Skip to content

itsJash/MyDollarBot-BOTGo

 
 

Repository files navigation

💰 TrackMyDollar V4.0 - Budget On The Go(BOTGo) 💰

https://www.youtube.com/watch?v=9fJScubX-cI

This video shows only the new features and enhancement of some older features. All the other features from phase 3 are working as it is.


Expense tracking made easy!


MIT license Platform GitHub GitHub contributors DOI Test and Formatting

GitHub issues GitHub closed issues Fork


About TrackMyDollar

TrackMyDollar 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 a new spending
  • 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
  • Add a recurring expense
  • User can add a new category and delete an existing category
  • User can see the budget value for the total expense
  • Added pie charts, bar graphs with and without budget lines
  • Deployment on GCP

What's new? (From Phase 3 to Phase 4)

  • Email Transaction History: Users can request their complete transaction history via email for easy access and record-keeping.
  • CSV Transaction History Extraction: Users can download their transaction history in CSV format, providing a versatile data export option for analysis.
  • Receipt Management: Users can upload and retrieve receipts for specific transactions by date, simplifying expense tracking and documentation.
  • Transaction Limit Notifications: Users can set transaction limits and receive alerts when expenses exceed the specified limits, helping them stay within budget.
  • Github Actions Automation: Automated testing, code formatting, and syntax checks have been implemented through Github Actions. A minimum 80% code coverage is required for successful builds, ensuring code quality and testing standards are maintained.

What more can be done?

Please refer to the issue list available here to see what more can be done to make MyDollarBot better. Please refer to the MyDollarBot project present here to have a look at the tasks done or in progress

Demo

Project.2.mp4

Installation guide

The below instructions can be followed in order to set-up this bot at your end in a span of few minutes! Let's get started:

  1. Clone this repository to your local system.

  2. Start a terminal session in the directory where the project has been cloned. Run the following command to install the required dependencies:

  pip install -r requirements.txt
  1. In Telegram, search for "BotFather". Click on "Start", and enter the following command:
  /newbot

Follow the instructions on screen and choose a name for your bot. After this, select a username for your bot that ends with "bot".

  1. BotFather will now confirm the creation of your bot and provide a TOKEN to access the HTTP API - copy and save this token for future use.

  2. Copy the token provided by the bot and add/replace it in the user.properties file (in the format api_token=<your_token>).

  3. In the directory where this repo has been cloned, please run the below command to execute a bash script to run the Telegram Bot:

   ./run.sh

(OR)

   bash run.sh

(Please Note: You may require to run chmod +x run.sh on mac/linux)

A successful run will generate a message on your terminal that says "TeleBot: Started polling."

  1. In the Telegram app, search for your newly created bot by entering the username and open the same. Now, on Telegram, enter the "/start" or "/menu" command, and you are all set to track your expenses!

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 -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 along with it, code coverage is computed. 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

Please note: A coverage below 80% will cause the build to fail.

Notes:

You can download and install the Telegram desktop application for your system from the following site: https://desktop.telegram.org/


Title:'Track My Dollar'

Version: '4.2'

Description: 'An easy to use Telegram Bot to track everyday expenses'

Authors(Iteration 4):'Anuj, Bhavesh, Jash, Vaibhavi'

Authors(Iteration 3):'Vraj, Alex, Leo, Prithvish, Seeya'

Authors(Iteration 2):'Athithya, Subramanian, Ashok, Zunaid, Rithik'

Authors(Iteration 1):'Dev, Prakruthi, Radhika, Rohan, Sunidhi'

About

CSC 510 Project Repository for Group 8

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.1%
  • Shell 0.9%