Giter Club home page Giter Club logo

dollar_bot's Introduction

๐Ÿ’ฐ Expense Management Bot ๐Ÿ’ฐ

Table of Contents
  1. Why should you use Expense-Management-Bot?
  2. Check out the video!
  3. What is new in this version?
  4. Installation
  5. Testing
  6. Code Coverage
  7. License
  8. Code Documentation
  9. How to Contribute
  10. Future RoadMap
  11. Contributors
  12. Acknowledgements

Dollar BoT


ForTheBadge built-with-love

MIT license Platform Platform GitHub GitHub contributors DOI Build Status codecov

GitHub issues GitHub closed issues


Why should you use Expense Management Bot?

Expense-Management-Bot is an easy-to-use Telegram Bot that assists you in recording your daily expenses on a local system without any hassle.
With simple commands, this bot allows you to:

  • Add/Record new spendings
  • Display your spendings through a bar graph
  • Show the sum of your expenditure for the current day/month
  • Display your spending history
  • Clear/Erase all your records
  • Edit/Change any spending details if you wish to
  • Visualize your spending patterns
  • Export your spending history to tools like Excel and perform an analysis
  • If telegram isn't convenient enough, use discord

Check out the video!

Please refer to this Video to understand the working and what's new in the telegram bot!

This video can be referred to see the added functionality of discord works.

What is new in this version?

Checkout the documentation

Rubric for Project 3: Rubric

Installation

Please follow the instructions in this documentation for installing and running the bot.

Testing

We use pytest to perform testing on all unit tests together. The command needs to be run from the home directory of the project. The command is:

python run -m pytest test/

Code Coverage

Code coverage is part of the build. Every time new code is pushed to the repository, the build is run, and code coverage is computed along with it. This can be viewed by selecting the build, and then choosing the codecov pop-up on hover.

Locally, we use the coverage package in Python for code coverage. The commands to check code coverage in Python are as follows:

coverage run -m pytest test/
coverage report

License

This project is licensed under the terms of the MIT license. Please check License for more details.

Code Documentation

Checkout the code documentation

How to Contribute

We would be happy to receive contributions! If you'd like to, please go through our CONTRIBUTING.md

Please create an issue here for any feedback, issues, or bug reports.

Future RoadMap

  • The bot can be integrated with Slack like it is currently done with Discord to make it seamless to use.
  • More content can be added for the way notifications can be displayed on the user front. This can be done to make the UI more interactive.

Contributors


Mrityunjay Joshi

Atharva Thorve


Divit Kalathil


Raghav Narula

Chat Channel

Acknowledgements

  • We would like to express our gratitude ๐Ÿ™๐Ÿป and a big thank you ๐Ÿ˜‡ to Prof. Dr. Timothy Menzie for giving us the opportunity to get into the shoes of software building and learning new skills and development process throughout the project building.
  • A big thank you ๐Ÿ˜Š to the Teaching Assistants for their support.
  • Thank you to the previous team ๐Ÿ˜Š for a thorough ReadMe and deatiled documentation.ExpenseManagementBot
  • Thank you to the โญ๏ธTelegram bot
  • Thank you to the โญ๏ธDiscord bot

dollar_bot's People

Contributors

radhikaraman20 avatar sak1997 avatar sak007 avatar sunidhihegde avatar usmanwardag avatar sbosenc avatar shrishty19 avatar prakruthisomashekar avatar deekay2310 avatar ebanigogia avatar atharvathorve avatar rhythmjagota avatar kriti0207 avatar wizard-31 avatar zedunaid avatar divitkalathil avatar mrityunjay243 avatar aakriti0fnu avatar rohansinha96 avatar rjain09 avatar muskan7828 avatar raghavnarula avatar

Stargazers

 avatar

Forkers

divitkalathil

dollar_bot's Issues

Support for other Currencies

Currently, the currency supported by the application is USD.

ToDo:

  • Users should be able to add expenses/budget in any currency they want
  • Work on current conversion rates. (No stale conversion rates)
  • Store data in all formats of currency
  • Users should be able to view transactions in any currency

Pdf for date range

Currently, when we export transaction history in PDF format, all the transactions are put in the pdf.

ToDo: Modify the existing /pdf command so that the user can also get the option to specify the date range, so only the transactions noted on those days will be present in the pdf.

Major Feature: Slack Integration

Similar to #5 also add integration for Slack application.

Therefore, the app won't be limited only to one platform and can be easily adopted by people with various needs.

Update Documentation

Current documentation is outdated and needs to be updated to reflect the new features added in the telegram bot

Add support command

This command will help users get support for the application and be able to get in touch with the developers.

Update Readme

The current readme is outdated and needs more attention and fixes.

Export Command

In many applications, data might be needed in different formats. PDF is user-friendly but not very helpful for different software.

Therefore, add a new command export to data in Excel and CSV form.

Major Feature: Add Discord Support

The current application is only limited to telegram right now.

Add a feature so that the bot is also available on other applications like Discord.

Search by Category

Currently, the history of transactions is shown for all categories.

ToDo: Add a command for the user to be able to filter transaction history by a specific category.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.