Table of Contents
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
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.
Checkout the documentation
Rubric for Project 3: Rubric
Please follow the instructions in this documentation for installing and running the bot.
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 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
This project is licensed under the terms of the MIT license. Please check License for more details.
Checkout the code documentation
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.
- 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.
Mrityunjay Joshi |
Atharva Thorve |
Divit Kalathil |
Raghav Narula |
- 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