Skip to content

Mrityunjay243/dollar_bot

 
 

Repository files navigation

💰 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

About

Telegram bot to track your expenses.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 57.8%
  • Python 41.9%
  • Shell 0.3%