diff --git a/.github/ISSUE_TEMPLATE/bug-template.md b/.github/ISSUE_TEMPLATE/bug-template.md new file mode 100644 index 000000000..0d9defcae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-template.md @@ -0,0 +1,10 @@ +--- +name: Bug Issue Reports +about: Create a bug report to help DollarBot improve! +title: 'Bug in : describe the bug in a few words>' +labels: 'bug' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 956abfc2d..000000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: To make contributors familiar with the structure for reporting or opening issues -title: 'to-do ' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/docu-template.md b/.github/ISSUE_TEMPLATE/docu-template.md new file mode 100644 index 000000000..a1435eb87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docu-template.md @@ -0,0 +1,10 @@ +--- +name: Documentation Improvement Ideas +about: Exactly explain the issue and what you wish existed instead / what can be improved in the documentation. +title: 'Docu Issue in: "the section where documentation is lacking"' +labels: 'documentation' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 000000000..bb9057432 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,8 @@ +--- +name: Enhancement Suggestions +about: Have cool feature enhancement ideas? Share here! +title: 'Enhancement: XYZ in ABC feature' +labels: 'enhancement' +assignees: '' + +--- diff --git a/.github/ISSUE_TEMPLATE/issue-task-template.md b/.github/ISSUE_TEMPLATE/issue-task-template.md deleted file mode 100644 index a3c82bdf6..000000000 --- a/.github/ISSUE_TEMPLATE/issue-task-template.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Issue Task Template -about: To make contributors familiar with the structure for reporting or opening issues -title: 'to-do ' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/other-issues.md b/.github/ISSUE_TEMPLATE/other-issues.md new file mode 100644 index 000000000..cd2128dc8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issues.md @@ -0,0 +1,8 @@ +--- +name: Other Issue Reports +about: Don't see your issue above? Tell us here. +title: 'Issue in : describe the issue in a few words>' +labels: '' +assignees: '' + +--- diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml new file mode 100644 index 000000000..04b824a92 --- /dev/null +++ b/.github/workflows/python-app.yml @@ -0,0 +1,45 @@ +# This workflow will install Python dependencies, run tests and lint, and check for code coverage with a single version of Python +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: Python application + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +permissions: + contents: read + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3.10 + uses: actions/setup-python@v3 + with: + python-version: "3.10" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pip install coverage + coverage run -m pytest test/ + - name: Upload coverage reports to Codecov + uses: codecov/codecov-action@v3 + with: + token: ${{ secrets.CODECOV_TOKEN }} + env_vars: OS,PYTHON diff --git a/.gitignore b/.gitignore index 507090ef0..7407d15c7 100644 --- a/.gitignore +++ b/.gitignore @@ -133,3 +133,4 @@ dmypy.json # Generated files expense_record.json +user.properties \ No newline at end of file diff --git a/A_Project2_Submission/Proj2-SelfAssessmentRubric.md b/A_Project2_Submission/Proj2-SelfAssessmentRubric.md new file mode 100644 index 000000000..df492e939 --- /dev/null +++ b/A_Project2_Submission/Proj2-SelfAssessmentRubric.md @@ -0,0 +1,108 @@ +For each items, score yourself zero (none), one (a litte), two (somewhat), three (a lot). +Total Score = 88 / 90 +|Notes|evidence|Score| +|-----|---------|---| +|Video| https://www.youtube.com/watch?v=XlndmRhr9Lc | 3 | +|Workload is spread over the whole team (one team member is often Xtimes more productive than the others... +but nevertheless, here is a track record that everyone is contributing a lot)| (Repo Traffic History)[https://github.com/aditikilledar/dollar_bot_SE23/graphs/traffic] | 3 | +|Number of commits|(Commit History)[https://github.com/aditikilledar/dollar_bot_SE23/graphs/commit-activity]| 3 | +|Number of commits: by different people|(Commit Contribution History)[https://github.com/aditikilledar/dollar_bot_SE23/graphs/contributors] | 3 | +|Issues reports: there are **many**| https://github.com/aditikilledar/dollar_bot_SE23/issues?q=is%3Aissue | 3 | +|Issues are being closed| https://github.com/aditikilledar/dollar_bot_SE23/issues?q=is%3Aissue+is%3Aclosed | 3 | +|DOI badge: exists|In (README.md)[https://github.com/aditikilledar/dollar_bot_SE23/blob/main/README.md]| 3 | +|Docs: doco generated, format not ugly |Also in (README.md)[https://github.com/aditikilledar/dollar_bot_SE23/blob/main/README.md]| 3 | +|Docs: what: point descriptions of each class/function (in isolation) | (Extensive documentation)[https://github.com/aditikilledar/dollar_bot_SE23/tree/main/docs] | 3 | +|Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z| (in the docu)[https://github.com/aditikilledar/dollar_bot_SE23/tree/main/docs] | 3 | +|Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing| | 3 +|Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.| Click here for a video overview!! | 3 +|Use of version control tools| Hosted on GitHub (Repo link)[https://github.com/aditikilledar/dollar_bot_SE23/] | 3 +|Use of style checkers |config files in GH showing your config| 2 +|Use of code formatters. |config files in GH showing your this formatter's config| 2 +|Use of syntax checkers. | Python & VSCode Syntax checkers | 3 | +|Use of code coverage | (Config file in GH)[https://github.com/aditikilledar/dollar_bot_SE23/blob/main/.github/workflows/python-app.yml] | 3 | +|Other automated analysis tools|[config files in GH](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/.github/workflows/python-app.yml)| 3 +|Test cases exist| dozens of tests and those test cases are more than 30% of the code base| 3 | +|Test cases are routinely executed| GitHub Actions | 3 | +|The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up| (Contributing.md)[https://github.com/aditikilledar/dollar_bot_SE23/blob/main/CONTRIBUTING.md] | 3 | +|Issues are discussed before they are closed | (Many were discussed but here is one such example)[https://github.com/aditikilledar/dollar_bot_SE23/issues/22] | 3 | +| Chat channel: exists| https://drive.google.com/drive/folders/1yVlqYdZ3ZScGU9_xKBDtW26CA2zcaObO | 3 +|Test cases: a large proportion of the issues related to handling failing cases. | (If a test case fails, open an issue and fix it)[https://github.com/aditikilledar/dollar_bot_SE23/issues/] | 3 +|Evidence that the whole team is using the same tools: everyone can get to all tools and files| Everyone can run and use our version of dollarbot. | 3 +|Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people)| [Common Requirements.txt used by everyone](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/requirements.txt) | 3 +|Evidence that the whole team is using the same tools (e.g. tutor can ask anyone to share screen, they demonstrate the system running on their computer)| | 3 +|Evidence that the members of the team are working across multiple places in the code base| (PR's by different people working on multiple places in the code bae)[https://github.com/aditikilledar/dollar_bot_SE23/pulse] | 3 | +|Short release cycles | (hard to see in short projects) (project members are committing often enough so that everyone can get your work)[https://github.com/aditikilledar/dollar_bot_SE23/releases] | 3 | + +## Software Sustainability Evaluation +| Question No.|Description |Y/N | +|-----|---------|---| +| 1.1 | https://github.com/aditikilledar/dollar_bot_SE23/tree/main#readme | Y | +| 1.2 | | Y | +| 1.3 | | N | +|2.1 | DollarBot | Y | +|2.2 | | Y | +|3.1 | | Y | +|3.2 | | Y | +|3.3 | | Y | +|3.4 | | Y | +|4.1 | | Y | +|4.2 | | Y | +|4.3 | | Y | +|4.4 | | Y | +|4.5 | | Y | +|4.6 | | Y | +|4.7 | | Y | +|4.8 | | Y | +|5.1 | | Y | +|5.2 | | N | +|5.3 | | N | +|5.4 | | NA| +|5.5 | | Y| +|5.6 | | Y| +|6.1 |https://github.com/aditikilledar/dollar_bot_SE23/tree/main/code| Y| +|6.2 | | Y| +|7.1 | | Y| +|7.2 | | Y| +|8.1 | | Y| +|9.1 | | Y| +|9.2 | | Y| +|10.1 | | Y| +|10.2 | | Y| +|10.3 | https://github.com/aditikilledar/dollar_bot_SE23/releases | Y| +|10.4 | | Y| +|10.5 | | Y| +|11.1 | | Y| +|11.2 | | Y| +|11.3 | | Y| +|11.4 | | Y| +|11.5 | | Y| +|11.6 | | Y| +|11.7 | | Y| +|11.8 | https://github.com/aditikilledar/dollar_bot_SE23/blob/main/.github/workflows/python-app.yml | Y| +|12.1 | | Y| +|12.2 | | Y| +|12.3 | | Y| +|12.4 | | Y| +|12.5 | | Y| +|13.1 | | N| +|13.2 | | Y| +|13.3 | | N| +|13.4 | | Y| +|13.5 | | Y| +|13.6 | | Y| +|13.7 | | Y| +|13.8 | | Y| +|14.1 | | Y| +|14.2 | | Y| +|14.3 | https://github.com/aditikilledar/dollar_bot_SE23/blob/main/CONTRIBUTING.md | Y| +|14.4 | | Y| +|15.1 | | Y| +|15.2 | | Y| +|15.3 | | Y| +|15.4 | | Y| +|15.5 | | Y| +|15.6 | | Y| +|15.7 | | Y| +|16.1 | https://github.com/aditikilledar/dollar_bot_SE23/tree/main#future-work | Y| +|16.2 | | N| +|16.3 | | N| diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index ff82f7f5a..35d2e5dcc 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -126,3 +126,5 @@ enforcement ladder](https://github.com/mozilla/diversity). For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. + +We hope to see all contributions to our repository strictly adhereing to our code of conduct detailed above, to make contributions to DollarBot safe and welcoming. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md old mode 100755 new mode 100644 index c9af5982f..56a4ccb73 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,19 @@ -# Contributing to MyDollarBot +# Contributing to DollarBot -Follow the set of guidelines below to contribute to MyDollarBot! +Follow the set of guidelines below to contribute to DollarBot! ## Code of Conduct -This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/usmanwardag/dollar_bot/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to upload this code. Please report unacceptable behavior to sbose2@ncsu.edu. +This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to upload this code. Please report unacceptable behavior to akilled@ncsu.edu. + +Note that this project is created as part of CSC 510 Coursework at NC State University for Fall'23. Prerequistes required before starting this project: +- Working Python Knowledge +- Some knowledge of Telegram Bots If you like our project and would like to contribue otherwise, please note: -1. This project is created as part of CSC510 Coursework at NC State for Fall'21. -2. If you like to contribute, reach out to the maintainers before creating a branch, to confirm if we're still maintaining the repo. -3. Have good understanding of Python Programming Language and Telegram Bots +Before creating a branch, reach out to the maintainers to confirm if the reposityory is still being actively maintained. ## How can I Contribute - @@ -41,7 +43,7 @@ A cursory search is necessary to check if the reported bug is already mentioned ## To Submit A Good Bug Report -[GitHub issues](https://github.com/usmanwardag/dollar_bot/issues) You can track the bugs from this. For the repository that has bug, create an issue and fill out [the template](https://github.com/atom/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) to give details of the bug. +[GitHub issues](https://github.com/aditikilledar/dollar_bot_SE23/issues) You can track the bugs from this. For the repository that has bug, create an issue and fill out [this template](https://github.com/atom/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) or our in-repo template to give details of the bug. * To identify the problem, give the issue a clear and informative term.
@@ -70,7 +72,7 @@ Check out this [debugging guide](https://flight-manual.atom.io/hacking-atom/sect ## To Submit A Good Enhancement Suggestion -[GitHub issues](https://github.com/usmanwardag/dollar_bot/issues) You can track the bugs from this. For the repository that has bug, create an issue and fill out [the template](https://github.com/atom/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) to give details of the bug. +[GitHub issues](https://github.com/aditikilledar/dollar_bot_SE23/issues) You can track the bugs from this. For the repository that has bug, create an issue and fill out [the template](https://github.com/atom/.github/blob/master/.github/ISSUE_TEMPLATE/bug_report.md or our in-repo enhancement template to give details of the bug. * To identify the problem, give the issue a clear and informative term.
* Describe in as much detail as possible to duplicate the problem. Explain the problem and explain about the exact command sused in the terminal which caus ethe bug to occur. diff --git a/Developer_ReadMe.md b/Developer_ReadMe.md new file mode 100644 index 000000000..c92e7b51e --- /dev/null +++ b/Developer_ReadMe.md @@ -0,0 +1,68 @@ +# For Developers: From the Developers of DollarBot + +
+ Table of Contents +
    +
  1. Function Documentation
    2. +
  2. Testing
    3. +
  3. Code Coverage
    4. +
  4. License
    5. +
  5. Code Documentation
    6. +
  6. How to Contribute
    7. +
  7. Future RoadMap
    8. +
+
+ +## Code Documentation by Functionality + +For a detailed explanation of the code, follow the links below: + +
    +
  1. Main Code File
    2. + Features: +
  2. Add
    3. +
  3. Budget Delete
    4. +
  4. Budget Update
    5. +
  5. Budget View
    6. +
  6. Delete
    7. +
  7. Display
    8. +
  8. Estimate
    9. +
  9. Graphing
    10. +
  10. Helper
    11. +
  11. History
    12. +
+ + +## 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 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 +``` + +## License + +This project is licensed under the terms of the MIT license. Please check [License](https://github.com/usmanwardag/dollar_bot/blob/main/LICENSE) for more details. + + +## How to Contribute + +We would be happy to receive contributions! If you'd like to, please go through our [CONTRIBUTING.md](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/CONTRIBUTING.md) + +For any feedback, issues, or bug reports, please create an issue [here](https://github.com/aditikilledar/dollar_bot_SE23/issues/new/choose). + +## Future RoadMap + +- 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. +- Recurring expenses feature can be added for faster addition of expenses instead of following the whole process of everytime. diff --git a/Proj2-SelfAssessmentRubric.md b/Proj2-SelfAssessmentRubric.md deleted file mode 100644 index ae857fecb..000000000 --- a/Proj2-SelfAssessmentRubric.md +++ /dev/null @@ -1,26 +0,0 @@ -|Score | Notes | Evidence | -|-----|------|------| -|.5 | Short release cycles| 2 Releases -> https://github.com/sak007/MyDollarBot-BOTGo/releases | -|.5 | Workload is spread over the whole team | Each memeber worked on a different feature -> https://github.com/sak007/MyDollarBot-BOTGo/pulse | -|.5 | Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing | Updated documentation for each feature -> https://github.com/sak007/MyDollarBot-BOTGo/tree/main/docs| -|.5 | File CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up| https://github.com/sak007/MyDollarBot-BOTGo/blob/main/CONTRIBUTING.md | -|.5 | Docs: doco generated , format not ugly| https://github.com/sak007/MyDollarBot-BOTGo/tree/main/docs| -|.5 | evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) | | -|.5 | evidence that the members of the team are working across multiple places in the code base| https://github.com/sak007/MyDollarBot-BOTGo/pulse| -|1 | Docs: what: point descriptions of each class/function (in isolation)| https://github.com/sak007/MyDollarBot-BOTGo/tree/main/docs| -|.5 | Number of commits: by different people| https://github.com/sak007/MyDollarBot-BOTGo/graphs/commit-activity | -|1 | issues are being closed| 26 Issues closed -> https://github.com/sak007/MyDollarBot-BOTGo/issues | -|.5 | issues are discussed before they are closed| Each issue updated with the discussion before closing and comments added -> https://github.com/sak007/MyDollarBot-BOTGo/issues| -|.5 | Use of syntax checkers.| Use of Flake8, updated in travis.yml -> https://github.com/sak007/MyDollarBot-BOTGo/blob/main/.travis.yml| -|1 | Issues reports: |https://github.com/sak007/MyDollarBot-BOTGo/issues | -|.5 | Use of code formatters.| config files in GH showing your this formatter's config| Use of Flake8, updated in travis.yml -> https://github.com/sak007/MyDollarBot-BOTGo/blob/main/.travis.yml | -|.5 | Use of style checkers config files in GH showing your config| Use of Flake8, updated in travis.yml -> https://github.com/sak007/MyDollarBot-BOTGo/blob/main/.travis.yml| -|.5 | Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.| Added in Readme.md -> https://github.com/sak007/MyDollarBot-BOTGo/blob/main/README.md| -|.5 | Test cases exist | 110 test cases with coverage > 80% for each file -> https://github.com/sak007/MyDollarBot-BOTGo/tree/main/test| -|.5 | Use of code coverage | https://github.com/sak007/MyDollarBot-BOTGo/blob/main/.travis.yml | -|.5 | other automated analysis tools | https://github.com/sak007/MyDollarBot-BOTGo/blob/main/.travis.yml | -|.5 | Test cases:.a large proportion of the issues related to handling failing cases. (if a test case fails, open an issue and fix it| https://github.com/sak007/MyDollarBot-BOTGo/issues | -|.5 | Test cases are routinely executed | https://app.codecov.io/gh/sak007/MyDollarBot-BOTGo | -|1 | Documentation describing how this version improves on the older version| Updated README.md to show the Delta -> https://github.com/sak007/MyDollarBot-BOTGo/blob/main/README.md | -|3 | This version is a little(1), some(2), much(3) improved on the last version. | Tutor's assessment | -|16 | Total | | diff --git a/Project Iteration 2 - New Features.pdf b/Project Iteration 2 - New Features.pdf deleted file mode 100644 index fe04beb06..000000000 Binary files a/Project Iteration 2 - New Features.pdf and /dev/null differ diff --git a/README.md b/README.md index 8e27f5f57..5bfaba11c 100644 --- a/README.md +++ b/README.md @@ -1,160 +1,195 @@ -# πŸ’° MyDollar Bot πŸ’° +# πŸ’° Dollar Bot πŸ’° -
- Table of Contents +

Table of Contents
    -
  1. Why should you use Dollar Bot?
    2. -
  2. Check out the video!
    3. -
  3. What is new in this version?
    4. -
  4. Installation
    5. -
  5. Testing
    6. -
  6. Code Coverage
    7. -
  7. License
    8. -
  8. Code Documentation
    9. -
  9. How to Contribute
    10. -
  10. Future RoadMap
    11. +
  11. What's DollarBot? +
  12. Why use DollarBot?
    13. +
  13. Demo
    14. +
  14. What's new in this version?
    15. +
  15. Installation and Setup
    16. +
  16. How to use?
  17. Contributors
    18. +
  18. Future Work
  19. Acknowledgements
-
-
-

-Dollar BoT -

-
- -[![ForTheBadge built-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://GitHub.com/usmanwardag/auto_anki) +Are you a developer? Click here: For Developers and Future Contributors ![MIT license](https://img.shields.io/badge/License-MIT-green.svg) [![Platform](https://img.shields.io/badge/Platform-Telegram-blue)](https://desktop.telegram.org/) ![GitHub](https://img.shields.io/badge/Language-Python-blue.svg) -[![GitHub contributors](https://img.shields.io/github/contributors/sak007/MyDollarBot-BOTGo)](https://github.com/sak007/MyDollarBot-BOTGo/graphs/contributors) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5759217.svg)](https://doi.org/10.5281/zenodo.5759217) +[![GitHub contributors](https://img.shields.io/github/contributors/aditikilledar/dollar_bot_SE23)](https://github.com/aditikilledar/dollar_bot_SE23/graphs/contributors) +[![DOI](https://zenodo.org/badge/691334031.svg)](https://zenodo.org/doi/10.5281/zenodo.10023639) [![Build Status](https://app.travis-ci.com/usmanwardag/dollar_bot.svg?branch=main)](https://app.travis-ci.com/usmanwardag/dollar_bot) -[![codecov](https://codecov.io/gh/usmanwardag/dollar_bot/branch/main/graph/badge.svg?token=PYAWX95R67)](https://codecov.io/gh/usmanwardag/dollar_bot) - -[![GitHub issues](https://img.shields.io/github/issues/sak007/MyDollarBot-BOTGo)](https://github.com/sak007/MyDollarBot-BOTGo/issues?q=is%3Aopen+is%3Aissue) -[![GitHub closed issues](https://img.shields.io/github/issues-closed/sak007/MyDollarBot-BOTGo)](https://github.com/sak007/MyDollarBot-BOTGo/issues?q=is%3Aissue+is%3Aclosed) -![Lines of code](https://img.shields.io/tokei/lines/github/sak007/MyDollarBot-BOTGo) +[![codecov](https://codecov.io/gh/aditikilledar/dollar_bot_SE23/graph/badge.svg?token=23RW1XPB3P)](https://codecov.io/gh/aditikilledar/dollar_bot_SE23) +[![GitHub closed issues](https://img.shields.io/github/issues-closed/aditikilledar/dollar_bot_SE23)](https://github.com/aditikilledar/dollar_bot_SE23/issues?q=is%3Aissue+is%3Aclosed) +
-## Why should you use MyDollar Bot? +## What's DollarBot? + +DollarBot is a handy little bot built on top of Telegram, to help you with daily expense tracking and analytics on your past spends. + +It's easy to setup, run and use on a daily basis! -Dollar 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: +Click here for a video overview!! + +## Why use DollarBot? + +With simple in-chat commands, this bot helps you: +- Set your own customized budget - Add/Record new spendings -- Display your spendings through bar graph -- Show the sum of your expenditure for the current day/month +- Display your spending trends through engaging graphs +- Predict your next month's budget based on your current expenditure - Display your spending history - Clear/Erase all your records - Edit/Change any spending details if you wish to +- View Analytics and export as a pdf -## Check out the video! +## Demo -[![Demo Video](https://i9.ytimg.com/vi/aCjcT1CHAzU/mq3.jpg?sqp=COSotI0G&rs=AOn4CLD34jFIlq6GRdmTnK6p3F8O2F-Yig)](https://youtu.be/aCjcT1CHAzU) +Demo Video -> [https://www.youtube.com/watch?v=XlndmRhr9Lc] -## What is new in this version? +## What's new? -Checkout the [this documentation](https://github.com/usmanwardag/dollar_bot/blob/main/docs/Updated_version.pdf) -## Installation +We've considerably extended this project to make using DollarBot easy and engaging.\ +1. Expressive Graphs +2. Budget prediction +3. Clearer and more informative PDF Reports +4. Ability to add recurring expenses +5. Budget Creation Updated +6. Clearer wording in the documentation -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: +Check [this documentation out](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/whats-new.md) for an in-depth depiction of our changes. :) -1. Clone this repository to your local system. +## Installation and Setup -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 +### Pre-requisite: The Telegram Desktop App -``` -3. Download and install the Telegram desktop application for your system from the following site: - ``` - https://desktop.telegram.org/ - ``` -## How to run? +Since DollarBot is built on top of Telegram, you'll first need: +1. Download the Telegram Desktop Application here. +```https://desktop.telegram.org/``` +2. Create a Telegram account or Sign in. -1. In Telegram, search for "BotFather". Click on "Start", and enter the following command: -``` - /newbot -``` -2. Follow the instructions on screen and choose a name for your bot (e.g., `dollarbot`). After this, select a username for your bot that ends with "bot". The username has to be unique. +Open up your terminal and let's get started: -3. 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. +### MacOS / Ubuntu Users -4. In the repo directory (where you cloned it), run these commands to (i) grant execution access to a bash script, and (ii) execute that bash script to run the Telegram Bot: +1. Clone this repository to your local system. ``` - chmod a+x run.sh - ./run.sh + git clone https://github.com/aditikilledar/dollar_bot_SE23/ ``` - -(OR) +2. Start a terminal session in the directory where the project has been cloned. Run the following commands and follow the instructions on-screen to complete the installation. ``` - chmod a+x run.sh - bash run.sh + chmod a+x setup.sh + bash setup.sh ``` -```Note```: It will ask you to paste the API token you received from Telegram in step 4. -A successful run will generate a message on your terminal that says "TeleBot: Started polling." +There, all done! -5. 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! +The installation is easy for MacOS or on UNIX terminals. -### Run Automatically at Startup +### Windows -To run the script automatically at startup / reboot, simply add the `.run_forever.sh` script to your `.bashrc` file, which executes whenever you reboot your system. +With Windows, you'll need to use a platform to execute UNIX-like commands in order to execute the setup.sh bash script. Once in the platform, use the steps in the MacOS/Unix Section above to setup DollarBot. + +We've used Cygwin, but there are more options like WSL that you can explore. + +Additionally, find more hints on Cygwin installation here. -## Testing +## Running DollarBot: -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: +Once you've executed setup.sh, and all dependencies have been installed, you can start running DollarBot by following these instructions. + +1. Open the Telegram Desktop Application and sign in. Once inside Telegram, search for "BotFather". Click on "Start", and enter the following command: ``` -python run -m pytest test/ + /newbot ``` +2. Follow the instructions on screen and choose a name for your bot (e.g., `dollarbot`). After this, select a UNIQUE username for your bot that ends with "bot", for example: `dollarbot_`. -## Code Coverage +3. 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. Make sure you save this token– don't lose it! -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. +4. In the repo directory (where you cloned it), run these commands. -Locally, we use the coverage package in python for code coverage. The commands to check code coverage in python are as follows: +(a) grant execution access to a bash script + ``` + chmod a+x run.sh + ``` +(b) execute the run.sh bash script to start DollarBot + +###### MacOS / Unix ``` -coverage run -m pytest test/ -coverage report + bash run.sh +``` +###### Windows +``` + ./run.sh ``` -## License +```Note```: It will ask you to paste the API token you received from Telegram while creating your bot (Step 3), so keep that handy. +A successful run will generate a message on your terminal that says "TeleBot: Started polling." -This project is licensed under the terms of the MIT license. Please check [License](https://github.com/usmanwardag/dollar_bot/blob/main/LICENSE) for more details. +5. In the Telegram app, search for your newly created bot by entering your UNIQUE username and open the bot you created. +6. Now, on Telegram, enter the "/start" or "menu" command, and you are all set to track your expenses! -## Code Documentation +### Run Automatically at Startup + +To run the script automatically at startup / reboot, simply add the `.run_forever.sh` script to your `.bashrc` file, which executes whenever you reboot your system. +Click here for help adding to .bashrc files. -Checkout the [docs](https://github.com/sak007/MyDollarBot-BOTGo/tree/main/docs) +## How to Use -## How to Contribute +Here's a quick overview of how each of the commands work. Simply enter / into the Telegram chat and watch as the magic happens! -We would be happy to receive contributions! If you'd like to, please go through our [CONTRIBUTING.md](https://github.com/usmanwardag/dollar_bot/blob/main/CONTRIBUTING.md) +#### /menu: Display commands with their descriptions. -For any feedback, issues, or bug reports, please create an issue [here](https://github.com/usmanwardag/dollar_bot/issues/new). +#### /help: Display the list of commands. -## Future RoadMap +#### /pdf: Save history as PDF. -- 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. -- Recurring expenses feature can be added for faster addition of expenses instead of following the whole process of everytime. +#### /add: This option is for adding your expenses + 1. It will give you the list of categories to choose from. + 2. You will be prompted to enter the amount corresponding to your spending + 3.The message will be prompted to notify the addition of your expense with the amount,date, time and category + +#### /analytics: This option gives user a graphical representation of their expenditures + You will get an option to choose the type of data you want to see. + +#### /predict: This option analyzes your recorded spendings and gives you a budget that will accommodate for them. + +#### /history: This option is to give you the detailed summary of your expenditure with Date, time ,category and amount. A quick lookup into your spendings + +#### /delete: This option is to Clear/Erase all your records + +#### /edit: This option helps you to go back and correct/update the missing details + 1. It will give you the list of your expenses you wish to edit + 2. It will let you change the specific field based on your requirements like amount/date/category + +#### /budget: This option is to set/update/delete the budget. + 1. The Add/update category is to set the new budget or update the existing budget + 2. The view category gives the detail if budget is exceeding or in limit with the difference amount + 3. The delete category allows to delete the budget and start afresh! ## Contributors - - - - - + + + +

Usman Khan
Aakriti Aakriti

Suneha Bose

Muskan Gupta

Kriti Khullar

Aditi Killedar
Shashank Madan

Srinath Srinivasan

Aditya Iyer
+## Future Work +- Sharing expenses +- Windows specific setup scripts +- Adding notes section while recording expenses +- Incorporating Machine Learning insights into the Analytics Feature +- Making DollarBot respond to casual conversation like 'Hi' and 'Bye' ## Acknowledgements @@ -162,7 +197,3 @@ For any feedback, issues, or bug reports, please create an issue [here](https:// - A big thank you 😊 to the Teaching Assistants for their support. - Thank you to the previous team 😊 for a thorough ReadMe and deatiled documentation.[MyDollarBot](https://github.com/sak007/MyDollarBot-BOTGo) - Thank you to the ⭐️[Telegram bot](https://github.com/python-telegram-bot/python-telegram-bot) - - - - diff --git a/code/.DS_Store b/code/.DS_Store deleted file mode 100644 index 87aa52603..000000000 Binary files a/code/.DS_Store and /dev/null differ diff --git a/code/add.py b/code/add.py index 906956ad1..87ee22c4a 100644 --- a/code/add.py +++ b/code/add.py @@ -3,12 +3,10 @@ from telebot import types from datetime import datetime - option = {} # === Documentation of add.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the add feature. @@ -18,40 +16,34 @@ def run(message, bot): and bot which is the telegram bot object from the main code.py function. """ helper.read_json() - chat_id = message.chat.id - option.pop(chat_id, None) # remove temp choice - markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) - markup.row_width = 2 - m = bot.send_message(chat_id, "Do you want to add a new category? Y/N") - bot.register_next_step_handler(m, post_user_def_category, bot) - - -def post_user_def_category(message, bot): markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) markup.row_width = 2 chat_id = message.chat.id - if str(message.text) == "Y" or str(message.text) == "y": - message1 = bot.send_message(chat_id, "Please enter your category") - bot.register_next_step_handler(message1, post_append_spend, bot) + expense_history = helper.getUserHistory(chat_id) + if expense_history: + recur_msg = bot.send_message(chat_id,"You have previously recorded expenses. Do you want to repeat one of these expenses?(Y/N)") + bot.register_next_step_handler(recur_msg, record_expense, bot, expense_history) else: for c in helper.getSpendCategories(): markup.add(c) + markup.add("Add new category") msg = bot.reply_to(message, "Select Category", reply_markup=markup) bot.register_next_step_handler(msg, post_category_selection, bot) - def post_append_spend(message, bot): - markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) markup.row_width = 2 selected_category = message.text - helper.spend_categories.append(selected_category) + chat_id = message.chat.id + allocated_categories = helper.getCategoryBudget(chat_id) + if selected_category not in allocated_categories.keys(): + helper.updateBudgetCategory(chat_id,selected_category) + helper.spend_categories.insert(0,selected_category) for c in helper.getSpendCategories(): markup.add(c) msg = bot.reply_to(message, "Select Category", reply_markup=markup) bot.register_next_step_handler(msg, post_category_selection, bot) - def post_category_selection(message, bot): """ post_category_selection(message, bot): It takes 2 arguments for processing - @@ -63,39 +55,83 @@ def post_category_selection(message, bot): try: chat_id = message.chat.id selected_category = message.text - if selected_category not in helper.getSpendCategories(): - bot.send_message( - chat_id, "Invalid", reply_markup=types.ReplyKeyboardRemove() - ) - raise Exception( - 'Sorry I don\'t recognise this category "{}"!'.format(selected_category) - ) - - option[chat_id] = selected_category - message = bot.send_message( - chat_id, - "How much did you spend on {}? \n(Enter numeric values only)".format( - str(option[chat_id]) - ), - ) - bot.register_next_step_handler( - message, post_amount_input, bot, selected_category - ) + if selected_category == "Add new category": + message1 = bot.send_message(chat_id, "Please enter your category") + bot.register_next_step_handler(message1, post_append_spend, bot) + else: + if selected_category not in helper.getSpendCategories(): + bot.send_message( + chat_id, "Invalid", reply_markup=types.ReplyKeyboardRemove() + ) + raise Exception( + 'Sorry, I don\'t recognise this category "{}"!'.format(selected_category) + ) + option[chat_id] = selected_category + message = bot.send_message( + chat_id, "How much did you spend on {}? \n(Numeric values only)".format(str(option[chat_id])),) + bot.register_next_step_handler(message, post_amount_input, bot, selected_category) except Exception as e: logging.exception(str(e)) bot.reply_to(message, "Oh no! " + str(e)) display_text = "" commands = helper.getCommands() - for ( - c - ) in ( - commands - ): # generate help text out of the commands dictionary defined at the top + for c in commands: + # generate help text out of the commands dictionary defined at the top display_text += "/" + c + ": " display_text += commands[c] + "\n" bot.send_message(chat_id, "Please select a menu option from below:") bot.send_message(chat_id, display_text) +def record_expense(message, bot, previous_expenses): + print("In function to record expense") + selection = message.text + print(selection) + markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) + markup.row_width = 2 + if selection == "Y" or selection == "y": + for record in previous_expenses: + markup.add(record) + msg = bot.reply_to(message, "Select the expense you want to repeat", reply_markup=markup) + bot.register_next_step_handler(msg, post_expense_selection, bot) + else: + for c in helper.getSpendCategories(): + markup.add(c) + markup.add("Add new category") + msg = bot.reply_to(message, "Select Category", reply_markup=markup) + bot.register_next_step_handler(msg, post_category_selection, bot) + +def post_expense_selection(message,bot): + chat_id = message.chat.id + expense_record = message.text + expense_data = expense_record.split(",") + amount = expense_data[2] + category = expense_data[1] + print(amount) + amount_value = helper.validate_entered_amount(amount) # validate + try: + if amount_value == 0: # cannot be $0 spending + raise Exception("Spent amount has to be a non-zero number.") + date_of_entry = datetime.today().strftime(helper.getDateFormat()) + date_str, category_str, amount_str = ( + str(date_of_entry), + str(category), + str(amount_value), + ) + helper.write_json( + add_user_record( + chat_id, "{},{},{}".format(date_str, category_str, amount_str) + ) + ) + bot.send_message( + chat_id, + "The following expenditure has been recorded: You have spent ${} for {} on {}".format( + amount_str, category_str, date_str + ), + ) + helper.display_remaining_budget(message, bot, category) + except Exception as e: + logging.exception(str(e)) + bot.reply_to(message, "Oh no. " + str(e)) def post_amount_input(message, bot, selected_category): """ @@ -107,7 +143,6 @@ def post_amount_input(message, bot, selected_category): """ try: print("---------------------------------------------------") - chat_id = message.chat.id print(chat_id) amount_entered = message.text @@ -119,21 +154,17 @@ def post_amount_input(message, bot, selected_category): raise Exception("Spent amount has to be a non-zero number.") date_of_entry = datetime.today().strftime( - helper.getDateFormat() + " " + helper.getTimeFormat() - ) - + helper.getDateFormat()) date_str, category_str, amount_str = ( str(date_of_entry), str(option[chat_id]), str(amount_value), ) - helper.write_json( add_user_record( chat_id, "{},{},{}".format(date_str, category_str, amount_str) ) ) - bot.send_message( chat_id, "The following expenditure has been recorded: You have spent ${} for {} on {}".format( @@ -145,7 +176,6 @@ def post_amount_input(message, bot, selected_category): logging.exception(str(e)) bot.reply_to(message, "Oh no. " + str(e)) - def add_user_record(chat_id, record_to_be_added): """ add_user_record(chat_id, record_to_be_added): Takes 2 arguments - @@ -161,7 +191,6 @@ def add_user_record(chat_id, record_to_be_added): user_list[str(chat_id)] = helper.createNewUserRecord() user_list[str(chat_id)]["data"].append(record_to_be_added) - print("!" * 5) print("after") print(user_list) diff --git a/code/analytics.py b/code/analytics.py new file mode 100644 index 000000000..ed130772e --- /dev/null +++ b/code/analytics.py @@ -0,0 +1,47 @@ +import helper +import logging +from telebot import types +import get_analysis + +def run(message, bot): + """ + run(message, bot): This is the main function used to implement the analytics feature. + It pop ups a menu on the bot asking the user to choose to view analytics + after which control is given to post_operation_selection(message, bot) for further proccessing. + It takes 2 arguments for processing - message which is the message from the user, and bot which is the + telegram bot object from the main code.py function. + """ + markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) + options = helper.getAnalyticsOptions() + markup.row_width = 2 + for c in options.values(): + markup.add(c) + msg = bot.reply_to(message, "Select the type of analysis (grouped by category):", reply_markup=markup) + bot.register_next_step_handler(msg, post_operation_selection, bot) + +def post_operation_selection(message, bot): + """ + post_operation_selection(message, bot): It takes 2 arguments for processing - message which + is the message from the user, and bot which is the telegram bot object from the + run(message, bot): function in the analytics.py file. Depending on the action chosen by the user, + it passes on control to the corresponding functions which are all located in different files. + """ + try: + chat_id = message.chat.id + op = message.text + options = helper.getAnalyticsOptions() + if op not in options.values(): + bot.send_message( + chat_id, "Invalid", reply_markup=types.ReplyKeyboardRemove() + ) + raise Exception('Sorry I don\'t recognise this operation "{}"!'.format(op)) + if op == options["overall"]: + get_analysis.viewOverallBudget(chat_id, bot) + elif op == options["spend"]: + get_analysis.viewSpendWise(chat_id, bot) + elif op == options["remaining"]: + get_analysis.viewRemaining(chat_id, bot) + elif op == options["history"]: + get_analysis.viewHistory(chat_id, bot) + except Exception as e: + helper.throw_exception(e, message, bot, logging) \ No newline at end of file diff --git a/code/budget.py b/code/budget.py index 0bd1359ae..d06840560 100644 --- a/code/budget.py +++ b/code/budget.py @@ -7,7 +7,6 @@ # === Documentation of budget.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the budget feature. @@ -24,7 +23,6 @@ def run(message, bot): msg = bot.reply_to(message, "Select Operation", reply_markup=markup) bot.register_next_step_handler(msg, post_operation_selection, bot) - def post_operation_selection(message, bot): """ post_operation_selection(message, bot): It takes 2 arguments for processing - message which @@ -48,5 +46,4 @@ def post_operation_selection(message, bot): elif op == options["delete"]: budget_delete.run(message, bot) except Exception as e: - # print("hit exception") - helper.throw_exception(e, message, bot, logging) + helper.throw_exception(e, message, bot, logging) \ No newline at end of file diff --git a/code/budget_delete.py b/code/budget_delete.py index a4462563c..e3062ab59 100644 --- a/code/budget_delete.py +++ b/code/budget_delete.py @@ -16,7 +16,7 @@ def run(message, bot): user_list = helper.read_json() print(user_list) if str(chat_id) in user_list: - user_list[str(chat_id)]["budget"]["overall"] = None - user_list[str(chat_id)]["budget"]["category"] = None + user_list[str(chat_id)]["budget"]["overall"] = str(0) + user_list[str(chat_id)]["budget"]["category"] = {} helper.write_json(user_list) bot.send_message(chat_id, "Budget deleted!") diff --git a/code/budget_update.py b/code/budget_update.py index df8041f4a..895914896 100644 --- a/code/budget_update.py +++ b/code/budget_update.py @@ -5,27 +5,19 @@ # === Documentation of budget_update.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the budget add/update features. It takes 2 arguments for processing - message which is the message from the user, and bot which is the telegram bot object from the main code.py function. """ - chat_id = message.chat.id - if helper.isOverallBudgetAvailable(chat_id): - update_overall_budget(chat_id, bot) - elif helper.isCategoryBudgetAvailable(chat_id): - update_category_budget(message, bot) - else: - markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) - options = helper.getBudgetTypes() - markup.row_width = 2 - for c in options.values(): - markup.add(c) - msg = bot.reply_to(message, "Select Budget Type", reply_markup=markup) - bot.register_next_step_handler(msg, post_type_selection, bot) - + markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) + options = helper.getBudgetTypes() + markup.row_width = 2 + for c in options.values(): + markup.add(c) + msg = bot.reply_to(message, "Select Budget Type", reply_markup=markup) + bot.register_next_step_handler(msg, post_type_selection, bot) def post_type_selection(message, bot): """ @@ -50,7 +42,6 @@ def post_type_selection(message, bot): except Exception as e: helper.throw_exception(e, message, bot, logging) - def update_overall_budget(chat_id, bot): """ update_overall_budget(message, bot): It takes 2 arguments for processing - message which is the @@ -70,7 +61,6 @@ def update_overall_budget(chat_id, bot): ) bot.register_next_step_handler(message, post_overall_amount_input, bot) - def post_overall_amount_input(message, bot): """ update_overall_budget(message, bot): It takes 2 arguments for processing - @@ -90,9 +80,21 @@ def post_overall_amount_input(message, bot): if str(chat_id) not in user_list: user_list[str(chat_id)] = helper.createNewUserRecord() user_list[str(chat_id)]["budget"]["overall"] = amount_value + total_budget = 0 + if helper.isCategoryBudgetAvailable(chat_id): + for c in helper.getCategoryBudget(chat_id).values(): + total_budget += float(c) + if total_budget > float(amount_value): + raise Exception("Overall budget cannot be less than " + str(total_budget)) + uncategorized_budget = helper.get_uncategorized_amount(chat_id, amount_value) + if float(uncategorized_budget) > 0: + if user_list[str(chat_id)]["budget"]["category"] is None: + user_list[str(chat_id)]["budget"]["category"] = {} + user_list[str(chat_id)]["budget"]["category"]["uncategorized"] = uncategorized_budget helper.write_json(user_list) bot.send_message(chat_id, "Budget Updated!") budget_view.display_overall_budget(message, bot) + print(user_list) return user_list except Exception as e: helper.throw_exception(e, message, bot, logging) @@ -111,6 +113,7 @@ def update_category_budget(message, bot): markup.row_width = 2 for c in categories: markup.add(c) + markup.add("Add new category") msg = bot.reply_to(message, "Select Category", reply_markup=markup) bot.register_next_step_handler(msg, post_category_selection, bot) @@ -128,34 +131,47 @@ def post_category_selection(message, bot): try: chat_id = message.chat.id selected_category = message.text - categories = helper.getSpendCategories() - if selected_category not in categories: - bot.send_message( - chat_id, "Invalid", reply_markup=types.ReplyKeyboardRemove() - ) - raise Exception( - 'Sorry I don\'t recognise this category "{}"!'.format(selected_category) - ) - if helper.isCategoryBudgetByCategoryAvailable(chat_id, selected_category): - currentBudget = helper.getCategoryBudgetByCategory( - chat_id, selected_category - ) - msg_string = "Current monthly budget for {} is {}\n\nEnter monthly budget for {}\n(Enter numeric values only)" - message = bot.send_message( - chat_id, - msg_string.format(selected_category, currentBudget, selected_category), - ) + if selected_category == "Add new category": + message1 = bot.send_message(chat_id, "Please enter your category") + bot.register_next_step_handler(message1, add_new_category, bot) else: - message = bot.send_message( - chat_id, - "Enter monthly budget for " + selected_category + "\n(Enter numeric values only)", + categories = helper.getSpendCategories() + if selected_category not in categories: + bot.send_message( + chat_id, "Invalid", reply_markup=types.ReplyKeyboardRemove() + ) + raise Exception( + 'Sorry I don\'t recognise this category "{}"!'.format(selected_category) + ) + if helper.isCategoryBudgetByCategoryAvailable(chat_id, selected_category): + currentBudget = helper.getCategoryBudgetByCategory( + chat_id, selected_category + ) + msg_string = "Current monthly budget for {} is {}\n\nEnter monthly budget for {}\n(Enter numeric values only)" + message = bot.send_message( + chat_id, + msg_string.format(selected_category, currentBudget, selected_category), + ) + else: + message = bot.send_message( + chat_id, + "Enter monthly budget for " + selected_category + "\n(Enter numeric values only)", + ) + bot.register_next_step_handler( + message, post_category_amount_input, bot, selected_category ) - bot.register_next_step_handler( - message, post_category_amount_input, bot, selected_category - ) except Exception as e: helper.throw_exception(e, message, bot, logging) +def add_new_category(message,bot): + markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) + markup.row_width = 2 + new_category = message.text + helper.spend_categories.append(new_category) + for c in helper.getSpendCategories(): + markup.add(c) + msg = bot.reply_to(message, "Select Category", reply_markup=markup) + bot.register_next_step_handler(msg, post_category_selection, bot) def post_category_amount_input(message, bot, category): """ @@ -174,10 +190,29 @@ def post_category_amount_input(message, bot, category): if user_list[str(chat_id)]["budget"]["category"] is None: user_list[str(chat_id)]["budget"]["category"] = {} user_list[str(chat_id)]["budget"]["category"][category] = amount_value - helper.write_json(user_list) message = bot.send_message( chat_id, "Budget for " + category + " is now: $" + amount_value ) + if helper.isCategoryBudgetByCategoryAvailable(chat_id, category): + currentBudget = helper.getCategoryBudgetByCategory(chat_id, category) + amount_value = str(float(amount_value) - float(currentBudget)) + if(user_list[str(chat_id)]["budget"]["overall"]) and user_list[str(chat_id)]["budget"]["overall"] != '0': + if 'uncategorized' in user_list[str(chat_id)]["budget"]["category"].keys(): + if round(float(user_list[str(chat_id)]["budget"]["category"]["uncategorized"]) - float(amount_value),2) > 0: + user_list[str(chat_id)]["budget"]["category"]["uncategorized"] = str(round(float(user_list[str(chat_id)]["budget"]["category"]["uncategorized"]) - float(amount_value),2)) + else: + user_list[str(chat_id)]["budget"]["category"]["uncategorized"] = str(0) + helper.write_json(user_list) + total_budget = 0 + for c in helper.getCategoryBudget(chat_id).values(): + total_budget += float(c) + print(total_budget) + user_list[str(chat_id)]["budget"]["overall"] = str(total_budget) + else: + user_list[str(chat_id)]["budget"]["overall"] = amount_value + helper.write_json(user_list) + budget_view.display_overall_budget(message, bot) + print(user_list) post_category_add(message, bot) except Exception as e: @@ -200,7 +235,6 @@ def post_category_add(message, bot): msg = bot.reply_to(message, "Select Option", reply_markup=markup) bot.register_next_step_handler(msg, post_option_selection, bot) - def post_option_selection(message, bot): """ post_option_selection(message, bot): It takes 2 arguments for processing - @@ -214,4 +248,4 @@ def post_option_selection(message, bot): options = helper.getUpdateOptions() print("here") if selected_option == options["continue"]: - update_category_budget(message, bot) + update_category_budget(message, bot) \ No newline at end of file diff --git a/code/budget_view.py b/code/budget_view.py index 077f8327b..5b56a2820 100644 --- a/code/budget_view.py +++ b/code/budget_view.py @@ -5,7 +5,6 @@ # === Documentation of budget_view.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the budget feature. @@ -19,9 +18,8 @@ def run(message, bot): try: print("here") chat_id = message.chat.id - if helper.isOverallBudgetAvailable(chat_id): + if helper.isOverallBudgetAvailable(chat_id) or helper.isCategoryBudgetAvailable(chat_id): display_overall_budget(message, bot) - elif helper.isCategoryBudgetAvailable(chat_id): display_category_budget(message, bot) else: raise Exception( @@ -30,7 +28,6 @@ def run(message, bot): except Exception as e: helper.throw_exception(e, message, bot, logging) - def display_overall_budget(message, bot): """ display_overall_budget(message, bot): It takes 2 arguments for processing - @@ -42,7 +39,6 @@ def display_overall_budget(message, bot): data = helper.getOverallBudget(chat_id) bot.send_message(chat_id, "Overall Budget: $" + data) - def display_category_budget(message, bot): """ display_category_budget(message, bot): It takes 2 arguments for processing - @@ -52,7 +48,10 @@ def display_category_budget(message, bot): format suitable for display, and returns the same through the bot to the Telegram UI. """ chat_id = message.chat.id - data = helper.getCategoryBudget(chat_id) - graphing.viewBudget(data) - bot.send_photo(chat_id, photo=open("budget.png", "rb")) - os.remove("budget.png") + if helper.isCategoryBudgetAvailable(chat_id): + data = helper.getCategoryBudget(chat_id) + graphing.viewBudget(data) + bot.send_photo(chat_id, photo=open("budget.png", "rb")) + os.remove("budget.png") + else: + bot.send_message(chat_id, "You are yet to set your budget for different categories.") \ No newline at end of file diff --git a/code/code.py b/code/code.py index 10bc43540..09a54eee5 100644 --- a/code/code.py +++ b/code/code.py @@ -12,6 +12,8 @@ import delete import add import budget +import analytics +import predict from datetime import datetime from jproperties import Properties @@ -31,8 +33,6 @@ # === Documentation of code.py === # Define listener for requests by user - - def listener(user_requests): """ listener(user_requests): Takes 1 argument user_requests and logs all user @@ -65,10 +65,8 @@ def listener(user_requests): except Exception: pass - bot.set_update_listener(listener) - @bot.message_handler(commands=["help"]) def help(m): @@ -80,11 +78,9 @@ def help(m): commands = helper.getCommands() for c in commands: message += "/" + c + ", " - # message += commands[c] + "\n\n" message += "\nUse /menu for detailed instructions about these commands." bot.send_message(chat_id, message) - @bot.message_handler(commands=["faq"]) def faq(m): @@ -98,7 +94,7 @@ def faq(m): '"How can I add an epxense?" \n' ">> Type /add, then select a category to type the expense. \n\n" '"Can I see history of my expenses?" \n' - ">> Yes! Use /display to get a graphical display, or /history to view detailed summary.\n\n" + ">> Yes! Use /analytics to get a graphical display, or /history to view detailed summary.\n\n" '"I added an incorrect expense. How can I edit it?"\n' ">> Use /edit command. \n\n" '"Can I check if my expenses have exceeded budget?"\n' @@ -106,7 +102,6 @@ def faq(m): ) bot.send_message(chat_id, faq_message) - # defines how the /start and /help commands have to be handled/processed @bot.message_handler(commands=["start", "menu"]) def start_and_menu_command(m): @@ -119,29 +114,21 @@ def start_and_menu_command(m): global user_list chat_id = m.chat.id - # print('receieved start or menu command.') - # text_into = "Welcome to the Dollar Bot!" - text_intro = ( ("Welcome to the Dollar Bot! \n" "DollarBot can track all your expenses with simple and easy to use commands :) \n" "Here is the complete menu. \n\n") ) - # "Type /faq or /help to get stated." commands = helper.getCommands() - for ( - c - ) in ( - commands - ): # generate help text out of the commands dictionary defined at the top + for c in commands: + # generate help text out of the commands dictionary defined at the top text_intro += "/" + c + ": " text_intro += commands[c] + "\n\n" bot.send_message(chat_id, text_intro) return True - -# defines how the /new command has to be handled/processed +# defines how the /add command has to be handled/processed @bot.message_handler(commands=["add"]) def command_add(message): """ @@ -151,10 +138,7 @@ def command_add(message): """ add.run(message, bot) - -# function to fetch expenditure history of the user - - +# handles pdf command @bot.message_handler(commands=["pdf"]) def command_pdf(message): """ @@ -164,7 +148,6 @@ def command_pdf(message): """ pdf.run(message, bot) - # function to fetch expenditure history of the user @bot.message_handler(commands=["history"]) def command_history(message): @@ -175,7 +158,6 @@ def command_history(message): """ history.run(message, bot) - # function to edit date, category or cost of a transaction @bot.message_handler(commands=["edit"]) def command_edit(message): @@ -186,7 +168,6 @@ def command_edit(message): """ edit.run(message, bot) - # function to display total expenditure @bot.message_handler(commands=["display"]) def command_display(message): @@ -197,13 +178,11 @@ def command_display(message): """ display.run(message, bot) - # function to estimate future expenditure @bot.message_handler(commands=["estimate"]) def command_estimate(message): estimate.run(message, bot) - # handles "/delete" command @bot.message_handler(commands=["delete"]) def command_delete(message): @@ -214,14 +193,28 @@ def command_delete(message): """ delete.run(message, bot) - +# handles budget command @bot.message_handler(commands=["budget"]) def command_budget(message): budget.run(message, bot) +# handles analytics command +@bot.message_handler(commands=["analytics"]) +def command_analytics(message): + """ + command_analytics(message): Take an argument message with content and chat ID. Calls analytics to + run analytics. Commands to run this commands=["analytics"] + """ + analytics.run(message, bot) -# not used - +# handles predict command +@bot.message_handler(commands=["predict"]) +def command_predict(message): + """ + command_predict(message): Take an argument message with content and chat ID. Calls predict to + analyze budget and spending trends and suggest a future budget. Commands to run this commands=["predict"] + """ + predict.run(message, bot) def addUserHistory(chat_id, user_record): global user_list @@ -230,7 +223,6 @@ def addUserHistory(chat_id, user_record): user_list[str(chat_id)].append(user_record) return user_list - def main(): """ main() The entire bot's execution begins here. It ensure the bot variable begins @@ -243,6 +235,5 @@ def main(): time.sleep(3) print("Connection Timeout") - if __name__ == "__main__": - main() + main() \ No newline at end of file diff --git a/code/delete.py b/code/delete.py index 6b7f9f2c1..c3a2649f2 100644 --- a/code/delete.py +++ b/code/delete.py @@ -2,7 +2,6 @@ # === Documentation of delete.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the delete feature. @@ -23,7 +22,6 @@ def run(message, bot): delete_history_text = "No records there to be deleted. Start adding your expenses to keep track of your spendings!" bot.send_message(chat_id, delete_history_text) - # function to delete a record def deleteHistory(chat_id): """ @@ -32,5 +30,7 @@ def deleteHistory(chat_id): """ global user_list if str(chat_id) in user_list: - del user_list[str(chat_id)] - return user_list + user_list[str(chat_id)]["data"] = [] + user_list[str(chat_id)]["budget"]["overall"] = str(0) + user_list[str(chat_id)]["budget"]["category"] = {} + return user_list \ No newline at end of file diff --git a/code/display.py b/code/display.py index 0d7715980..9b72b5f20 100644 --- a/code/display.py +++ b/code/display.py @@ -7,7 +7,6 @@ # === Documentation of display.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the delete feature. @@ -26,7 +25,6 @@ def run(message, bot): markup.row_width = 2 for mode in helper.getSpendDisplayOptions(): markup.add(mode) - # markup.add('Day', 'Month') msg = bot.reply_to( message, "Please select a category to see the total expense", @@ -34,7 +32,6 @@ def run(message, bot): ) bot.register_next_step_handler(msg, display_total, bot) - def display_total(message, bot): """ display_total(message, bot): It takes 2 arguments for processing - message which is @@ -63,7 +60,6 @@ def display_total(message, bot): time.sleep(0.5) total_text = "" - if DayWeekMonth == "Day": query = datetime.now().today().strftime(helper.getDateFormat()) # query all that contains today's date @@ -91,12 +87,10 @@ def display_total(message, bot): ) graphing.visualize(total_text, monthly_budget) bot.send_photo(chat_id, photo=open("expenditure.png", "rb")) - # os.remove('expenditure.png') except Exception as e: logging.exception(str(e)) bot.reply_to(message, str(e)) - def calculate_spendings(queryResult): """ calculate_spendings(queryResult): Takes 1 argument for processing - queryResult @@ -118,4 +112,4 @@ def calculate_spendings(queryResult): total_text = "" for key, value in total_dict.items(): total_text += str(key) + " $" + str(value) + "\n" - return total_text + return total_text \ No newline at end of file diff --git a/code/edit.py b/code/edit.py index ce0419734..d2bb43469 100644 --- a/code/edit.py +++ b/code/edit.py @@ -1,10 +1,10 @@ import helper from telebot import types from telegram_bot_calendar import DetailedTelegramCalendar, LSTEP +from datetime import datetime # === Documentation of edit.py === - def run(m, bot): """ run(message, bot): This is the main function used to implement the delete feature. @@ -15,7 +15,11 @@ def run(m, bot): chat_id = m.chat.id markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) markup.row_width = 2 - for c in helper.getUserHistory(chat_id): + user_history = helper.getUserHistory(chat_id) + if not user_history: + bot.send_message(chat_id,"You have no previously recorded expenses to modify") + return + for c in user_history: expense_data = c.split(",") str_date = "Date=" + expense_data[0] str_category = ",\t\tCategory=" + expense_data[1] @@ -24,7 +28,6 @@ def run(m, bot): info = bot.reply_to(m, "Select expense to be edited:", reply_markup=markup) bot.register_next_step_handler(info, select_category_to_be_updated, bot) - def select_category_to_be_updated(m, bot): info = m.text markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) @@ -33,11 +36,10 @@ def select_category_to_be_updated(m, bot): for c in selected_data: markup.add(c.strip()) choice = bot.reply_to(m, "What do you want to update?", reply_markup=markup) - bot.register_next_step_handler(choice, enter_updated_data, bot, selected_data) - - -def enter_updated_data(m, bot, selected_data): + updated = [] + bot.register_next_step_handler(choice, enter_updated_data, bot, selected_data, updated) +def enter_updated_data(m, bot, selected_data, updated): choice1 = "" if m.text is None else m.text markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) markup.row_width = 2 @@ -45,7 +47,6 @@ def enter_updated_data(m, bot, selected_data): markup.add(cat) if "Date" in choice1: - calendar, step = DetailedTelegramCalendar().build() bot.send_message(m.chat.id, f"Select {LSTEP[step]}", reply_markup=calendar) @@ -61,9 +62,7 @@ def cal(c): reply_markup=key, ) elif result: - - edit_date(bot, selected_data, result, c.message.chat.id) - + edit_date(bot, selected_data, result, c, updated) bot.edit_message_text( f"Date is updated: {result}", c.message.chat.id, @@ -71,27 +70,36 @@ def cal(c): ) if "Category" in choice1: - new_cat = bot.reply_to(m, "Please select the new category", reply_markup=markup) - bot.register_next_step_handler(new_cat, edit_cat, bot, selected_data) + bot.register_next_step_handler(new_cat, edit_cat, bot, selected_data, updated) if "Amount" in choice1: new_cost = bot.reply_to( m, "Please type the new cost\n(Enter only numerical value)" ) - bot.register_next_step_handler(new_cost, edit_cost, bot, selected_data) - - -def edit_date(bot, selected_data, result, chat_id): + bot.register_next_step_handler(new_cost, edit_cost, bot, selected_data, updated) + +def update_different_category(m, bot, selected_data, updated): + response = m.text + if response == "Y" or response == "y": + markup = types.ReplyKeyboardMarkup(one_time_keyboard=True) + markup.row_width = 2 + for c in selected_data: + if c not in updated: + markup.add(c.strip()) + choice = bot.reply_to(m, "What do you want to update?", reply_markup=markup) + bot.register_next_step_handler(choice, enter_updated_data, bot, selected_data, updated) + +def edit_date(bot, selected_data, result, c, updated): """ def edit_date(m, bot): It takes 2 arguments for processing - message which is the message from the user, and bot which is the telegram bot object from the edit3(m, bot):: function in the same file. It takes care of date change and edits. """ user_list = helper.read_json() - new_date = str(result) - - chat_id = chat_id + new_date = datetime.strftime(result, helper.getDateFormat()) + chat_id = c.message.chat.id + m = c.message data_edit = helper.getUserHistory(chat_id) for i in range(len(data_edit)): @@ -109,9 +117,16 @@ def edit_date(m, bot): It takes 2 arguments for processing - message which is user_list[str(chat_id)]["data"] = data_edit helper.write_json(user_list) + new_date_str = "Date=" + new_date + updated.append(new_date_str) + selected_data[0] = new_date_str + if len(updated) == 3: + bot.send_message(m.chat.id, "You have updated all the categories for this expense") + return + resp = bot.send_message(m.chat.id, "Do you want to update another category in this expense?(Y/N)") + bot.register_next_step_handler(resp, update_different_category, bot, selected_data ,updated) - -def edit_cat(m, bot, selected_data): +def edit_cat(m, bot, selected_data, updated): """ def edit_cat(m, bot): It takes 2 arguments for processing - message which is the message from the user, and bot which is the telegram bot object from the edit3(m, bot):: function in the @@ -134,10 +149,17 @@ def edit_cat(m, bot): It takes 2 arguments for processing - message which is the user_list[str(chat_id)]["data"] = data_edit helper.write_json(user_list) + new_cat_str = "Category=" + new_cat + updated.append(new_cat_str) + selected_data[1] = new_cat_str bot.reply_to(m, "Category is updated") + if len(updated) == 3: + bot.send_message(m.chat.id, "You have updated all the categories for this expense") + return + resp = bot.send_message(m.chat.id, "Do you want to update another category in this expense?(Y/N)") + bot.register_next_step_handler(resp, update_different_category, bot, selected_data, updated) - -def edit_cost(m, bot, selected_data): +def edit_cost(m, bot, selected_data, updated): """ def edit_cost(m, bot): It takes 2 arguments for processing - message which is the message from the user, and bot which is the telegram bot object from the @@ -164,4 +186,11 @@ def edit_cost(m, bot): It takes 2 arguments for processing - message which is th bot.reply_to(m, "Expense amount is updated") else: bot.reply_to(m, "The cost is invalid") + new_cost_str = "Category=" + new_cost + updated.append(new_cost_str) + selected_data[1] = new_cost_str + if len(updated) == 3: + bot.send_message(m.chat.id, "You have updated all the categories for this expense") return + resp = bot.send_message(m.chat.id, "Do you want to update another category in this expense?(Y/N)") + bot.register_next_step_handler(resp, update_different_category, bot, selected_data, updated) \ No newline at end of file diff --git a/code/estimate.py b/code/estimate.py index c03fb7e81..e9e48c7b1 100644 --- a/code/estimate.py +++ b/code/estimate.py @@ -5,7 +5,6 @@ # === Documentation of estimate.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the estimate feature. @@ -24,13 +23,11 @@ def run(message, bot): markup.row_width = 2 for mode in helper.getSpendEstimateOptions(): markup.add(mode) - # markup.add('Day', 'Month') msg = bot.reply_to( message, "Please select the period to estimate", reply_markup=markup ) bot.register_next_step_handler(msg, estimate_total, bot) - def estimate_total(message, bot): """ estimate_total(message, bot): It takes 2 arguments for processing - message which is the message @@ -67,7 +64,6 @@ def estimate_total(message, bot): # query all that contains today's date # query all that contains all history queryResult = [value for index, value in enumerate(history)] - total_text = calculate_estimate(queryResult, days_to_estimate) spending_text = "" @@ -84,7 +80,6 @@ def estimate_total(message, bot): logging.exception(str(e)) bot.reply_to(message, str(e)) - def calculate_estimate(queryResult, days_to_estimate): """ calculate_estimate(queryResult, days_to_estimate): Takes 2 arguments for processing - queryResult @@ -114,4 +109,4 @@ def calculate_estimate(queryResult, days_to_estimate): daily_avg = value / category_count estimated_avg = round(daily_avg * days_to_estimate, 2) total_text += str(key) + " $" + str(estimated_avg) + "\n" - return total_text + return total_text \ No newline at end of file diff --git a/code/get_analysis.py b/code/get_analysis.py new file mode 100644 index 000000000..1e496e574 --- /dev/null +++ b/code/get_analysis.py @@ -0,0 +1,56 @@ +import helper +import graphing +from telebot import types +import os + +def viewOverallBudget(chat_id, bot): + if not helper.isCategoryBudgetAvailable(chat_id): + bot.send_message(chat_id, "No category budget available", reply_markup=types.ReplyKeyboardRemove()) + return + category_budget = {} + for cat in helper.getCategoryBudget(chat_id): + if helper.isCategoryBudgetByCategoryAvailable(chat_id, cat): + cat_budget = helper.getCategoryBudgetByCategory(chat_id,cat) + if cat_budget != '0': + category_budget[cat] = cat_budget + graphing.overall_split(category_budget) + bot.send_photo(chat_id, photo=open("overall_split.png", 'rb'), reply_markup=types.ReplyKeyboardRemove()) + os.remove("overall_split.png") + +def viewSpendWise(chat_id, bot): + category_spend = {} + for cat in helper.getCategoryBudget(chat_id): + spend = helper.calculate_total_spendings_for_cateogory_chat_id(chat_id,cat) + if spend != 0: + category_spend[cat] = spend + + if category_spend == {}: + bot.send_message(chat_id, "No category spend available", reply_markup=types.ReplyKeyboardRemove()) + return + graphing.spend_wise_split(category_spend) + bot.send_photo(chat_id, photo=open("spend_wise.png", 'rb'), reply_markup=types.ReplyKeyboardRemove()) + os.remove("spend_wise.png") + +def viewRemaining(chat_id, bot): + if not helper.isCategoryBudgetAvailable(chat_id): + bot.send_message(chat_id, "No category budget available", reply_markup=types.ReplyKeyboardRemove()) + return + category_spend_percent = {} + for cat in helper.spend_categories: + if helper.isCategoryBudgetByCategoryAvailable(chat_id, cat): + percent = helper.calculateRemainingCateogryBudgetPercent(chat_id, cat) + category_spend_percent[cat] = percent + graphing.remaining(category_spend_percent) + bot.send_photo(chat_id, photo=open("remaining.png", 'rb'), reply_markup=types.ReplyKeyboardRemove()) + os.remove("remaining.png") + +def viewHistory(chat_id, bot): + if not helper.getUserHistory(chat_id): + bot.send_message(chat_id, "No history available", reply_markup=types.ReplyKeyboardRemove()) + return + + cat_spend_dict = helper.getUserHistoryDateExpense(chat_id) + + graphing.time_series(cat_spend_dict) + bot.send_photo(chat_id, photo=open("time_series.png", 'rb'), reply_markup=types.ReplyKeyboardRemove()) + os.remove("time_series.png") \ No newline at end of file diff --git a/code/graphing.py b/code/graphing.py index 8e08ce69b..d522a3c9c 100644 --- a/code/graphing.py +++ b/code/graphing.py @@ -6,7 +6,6 @@ # === Documentation of graphing.py === - def viewBudget(data): sorted_data = {} sorted_data = {k: v for k, v in sorted(data.items(), key=lambda item: item[1])} @@ -21,7 +20,6 @@ def viewBudget(data): plt.savefig("budget.png", bbox_inches="tight") plt.close() - def addlabels(x, y): """ addlabels(x, y): This function is used to add the labels to the graph. @@ -30,7 +28,6 @@ def addlabels(x, y): for i in range(len(x)): plt.text(i, y[i] // 2, y[i], ha="center") - def visualize(total_text, monthly_budget): """ visualize(total_text): This is the main function used to implement the graphing @@ -78,3 +75,54 @@ def visualize(total_text, monthly_budget): plt.legend() plt.savefig("expenditure.png", bbox_inches="tight") plt.close() + +def overall_split(category_budget): + _, ax = plt.subplots() + ax.pie(category_budget.values(), labels=category_budget.keys(), autopct='%1.1f%%') + ax.set_title("Budget split") + img_name = "overall_split.png" + plt.savefig(img_name) + plt.close() + +def spend_wise_split(category_spend): + _, ax = plt.subplots() + ax.pie(category_spend.values(), labels=category_spend.keys(), autopct='%1.1f%%') + ax.set_title("Category-wise spend") + img_name = "spend_wise.png" + plt.savefig(img_name) + plt.close() + +def remaining(category_spend_percent): + labels = tuple(category_spend_percent.keys()) + remaining_val_list = [100 - x for x in list(category_spend_percent.values())] + + weight_counts = { + "Used": list(category_spend_percent.values()), + "Remaining": remaining_val_list, + } + width = 0.5 + _, ax = plt.subplots() + bottom = np.zeros(len(list(category_spend_percent.values()))) + + for boolean, weight_count in weight_counts.items(): + print(boolean, weight_count) + ax.bar(labels, weight_count, width, label=boolean, bottom=bottom) + bottom += weight_count + + ax.set_title("Category-wise budget consumed") + plt.xlabel("Categories") + plt.ylabel("Percentage") + ax.legend(loc="upper right") + + img_name = "remaining.png" + plt.savefig(img_name) + plt.close() + +def time_series(cat_spend_dict): + plt.plot(cat_spend_dict.keys(), cat_spend_dict.values(), marker='o') + plt.title("Time-series of expenses") + plt.xlabel("Time") + plt.ylabel("Expense") + img_name = "time_series.png" + plt.savefig(img_name) + plt.close() \ No newline at end of file diff --git a/code/helper.py b/code/helper.py index 70c8c48d4..d18217a35 100644 --- a/code/helper.py +++ b/code/helper.py @@ -2,7 +2,6 @@ import json import os from datetime import datetime - from notify import notify spend_categories = [ @@ -17,24 +16,23 @@ spend_display_option = ["Day", "Month"] spend_estimate_option = ["Next day", "Next month"] update_options = {"continue": "Continue", "exit": "Exit"} - budget_options = {"update": "Add/Update", "view": "View", "delete": "Delete"} - budget_types = {"overall": "Overall Budget", "category": "Category-Wise Budget"} - data_format = {"data": [], "budget": {"overall": None, "category": None}} +analytics_options = {"overall": "Overall budget split", "spend": "Split of current spend", "remaining": "Remaining value", "history": "Time series graph of spend history"} # set of implemented commands and their description commands = { + "menu": "Display commands with their descriptions.", "help": "Display the list of commands.", "pdf": "Save history as PDF.", "add": "This option is for adding your expenses \ \n 1. It will give you the list of categories to choose from. \ \n 2. You will be prompted to enter the amount corresponding to your spending \ \n 3.The message will be prompted to notify the addition of your expense with the amount,date, time and category ", - "display": "This option gives user a graphical representation(bar graph) of their expenditures \ - \n You will get an option to choose from day or month for better analysis of the expenses.", - "estimate": "This option gives you the estimate of expenditure for the next day/month. It calcuates based on your recorded spendings", + "analytics": "This option gives user a graphical representation of their expenditures \ + \n You will get an option to choose the type of data you want to see.", + "predict": "This option analyzes your recorded spendings and gives you a budget that will accommodate for them.", "history": "This option is to give you the detailed summary of your expenditure with Date, time ,category and amount. A quick lookup into your spendings", "delete": "This option is to Clear/Erase all your records", "edit": "This option helps you to go back and correct/update the missing details \ @@ -53,8 +51,6 @@ # === Documentation of helper.py === # function to load .json expense record data - - def read_json(): """ read_json(): Function to load .json expense record data @@ -72,7 +68,6 @@ def read_json(): except FileNotFoundError: print("---------NO RECORDS FOUND---------") - def write_json(user_list): """ write_json(user_list): Stores data into the datastore of the bot. @@ -83,7 +78,6 @@ def write_json(user_list): except FileNotFoundError: print("Sorry, the data file could not be found.") - def validate_entered_amount(amount_entered): """ validate_entered_amount(amount_entered): Takes 1 argument, amount_entered. @@ -99,7 +93,6 @@ def validate_entered_amount(amount_entered): return str(amount) return 0 - def getUserHistory(chat_id): """ getUserHistory(chat_id): Takes 1 argument chat_id and uses this to get the relevant user's historical data. @@ -109,6 +102,21 @@ def getUserHistory(chat_id): return data["data"] return None +def getUserHistoryByCategory(chat_id, category): + data = getUserHistory(chat_id) + previous_expenses = [] + for record in data: + if f",{category}," in record: + previous_expenses.append(record) + return previous_expenses + +def getUserHistoryDateExpense(chat_id): + data = getUserHistory(chat_id) + cat_spend_dict = {} + for record in data: + split_vals = record.split(",") + cat_spend_dict[split_vals[0]] = split_vals[2] + return cat_spend_dict def getUserData(chat_id): user_list = read_json() @@ -118,64 +126,70 @@ def getUserData(chat_id): return user_list[str(chat_id)] return None - def throw_exception(e, message, bot, logging): logging.exception(str(e)) bot.reply_to(message, "Oh no! " + str(e)) - def createNewUserRecord(): return data_format - def getOverallBudget(chatId): data = getUserData(chatId) - if data is None: + if data is None or data == {}: return None return data["budget"]["overall"] - def getCategoryBudget(chatId): data = getUserData(chatId) if data is None: return None return data["budget"]["category"] - def getCategoryBudgetByCategory(chatId, cat): if not isCategoryBudgetByCategoryAvailable(chatId, cat): return None data = getCategoryBudget(chatId) return data[cat] - def canAddBudget(chatId): - return (getOverallBudget(chatId) is None) and (getCategoryBudget(chatId) is None) - + overall_budget = getOverallBudget(chatId) + category_budget = getCategoryBudget(chatId) + return (overall_budget is None and overall_budget != '0') and (category_budget is None and category_budget != {}) def isOverallBudgetAvailable(chatId): - return getOverallBudget(chatId) is not None - + overall_budget = getOverallBudget(chatId) + if overall_budget is not None and overall_budget != '0': + return True + return False def isCategoryBudgetAvailable(chatId): - return getCategoryBudget(chatId) is not None - + category_budget = getCategoryBudget(chatId) + if category_budget is not None and category_budget != {}: + return True + return False def isCategoryBudgetByCategoryAvailable(chatId, cat): data = getCategoryBudget(chatId) - if data is None: + if data is None or data == {}: return False return cat in data.keys() +def get_uncategorized_amount(chatId, amount): + overall_budget = float(amount) + category_budget_data = getCategoryBudget(chatId) + if category_budget_data is None or category_budget_data == {}: + return amount + category_budget = 0 + for c in category_budget_data.values(): + category_budget += float(c) + uncategorized_budget = overall_budget - category_budget + return str(round(uncategorized_budget,2)) def display_remaining_budget(message, bot, cat): print("inside") chat_id = message.chat.id - if isOverallBudgetAvailable(chat_id): - display_remaining_overall_budget(message, bot) - elif isCategoryBudgetByCategoryAvailable(chat_id, cat): - display_remaining_category_budget(message, bot, cat) - + display_remaining_category_budget(message, bot, cat) + display_remaining_overall_budget(message, bot) def display_remaining_overall_budget(message, bot): print("here") @@ -188,30 +202,26 @@ def display_remaining_overall_budget(message, bot): msg = ( "\nBudget Exceded!\nExpenditure exceeds the budget by $" + str(remaining_budget)[1:] ) - # notify() bot.send_message(chat_id, msg) - def calculateRemainingOverallBudget(chat_id): budget = getOverallBudget(chat_id) history = getUserHistory(chat_id) query = datetime.now().today().strftime(getMonthFormat()) - queryResult = [value for index, value in enumerate(history) if str(query) in value] - + queryResult = [value for _, value in enumerate(history) if str(query) in value] return float(budget) - calculate_total_spendings(queryResult) - def calculate_total_spendings(queryResult): total = 0 - for row in queryResult: s = row.split(",") total = total + float(s[2]) return total - def display_remaining_category_budget(message, bot, cat): chat_id = message.chat.id + if not getCategoryBudgetByCategory(chat_id,cat): + updateBudgetCategory(chat_id, cat) remaining_budget = calculateRemainingCategoryBudget(chat_id, cat) if remaining_budget >= 0: msg = "\nRemaining Budget for " + cat + " is $" + str(remaining_budget) @@ -222,83 +232,119 @@ def display_remaining_category_budget(message, bot, cat): msg = "\nRemaining Budget for " + cat + " is $" + str(remaining_budget) bot.send_message(chat_id, msg) - def calculateRemainingCategoryBudget(chat_id, cat): budget = getCategoryBudgetByCategory(chat_id, cat) history = getUserHistory(chat_id) query = datetime.now().today().strftime(getMonthFormat()) - queryResult = [value for index, value in enumerate(history) if str(query) in value] - + queryResult = [value for _, value in enumerate(history) if str(query) in value] return float(budget) - calculate_total_spendings_for_category(queryResult, cat) +def calculateRemainingCateogryBudgetPercent(chat_id, cat): + budget = getCategoryBudgetByCategory(chat_id, cat) + history = getUserHistory(chat_id) + query = datetime.now().today().strftime(getMonthFormat()) + queryResult = [value for _, value in enumerate(history) if str(query) in value] + return (calculate_total_spendings_for_category(queryResult, cat)/float(budget))*100 def calculate_total_spendings_for_category(queryResult, cat): total = 0 - for row in queryResult: s = row.split(",") if cat == s[1]: total = total + float(s[2]) return total +def calculate_total_spendings_for_cateogory_chat_id(chat_id, cat): + history = getUserHistory(chat_id) + query = datetime.now().today().strftime(getMonthFormat()) + queryResult = [value for _, value in enumerate(history) if str(query) in value] + return calculate_total_spendings_for_category(queryResult, cat) +def updateBudgetCategory(chatId, category): + user_list = read_json() + user_list[str(chatId)]["budget"]["category"][category] = str(0) + write_json(user_list) + +def getAvailableCategories(history): + available_categories = set() + for record in history: + available_categories.add(record.split(',')[1]) + return available_categories + +def getCategoryWiseSpendings(available_categories, history): + category_wise_history = {} + for cat in available_categories: + for record in history: + if cat in record: + if cat in category_wise_history.keys(): + category_wise_history[cat].append(record) + else: + category_wise_history[cat] = [record] + return category_wise_history + +def getFormattedPredictions(category_predictions): + category_budgets = "" + for key,value in category_predictions.items(): + if type(value) == float: + category_budgets += str(key) + ": $" + str(value) + "\n" + else: + category_budgets += str(key) + ": " + value + "\n" + predicted_budget = "Here are your predicted budgets" + predicted_budget += " for the next month \n" + predicted_budget += category_budgets + return predicted_budget + +#getters def getSpendCategories(): """ getSpendCategories(): This functions returns the spend categories used in the bot. These are defined the same file. """ return spend_categories - def getSpendDisplayOptions(): """ getSpendDisplayOptions(): This functions returns the spend display options used in the bot. These are defined the same file. """ return spend_display_option - def getSpendEstimateOptions(): return spend_estimate_option - def getCommands(): """ getCommands(): This functions returns the command options used in the bot. These are defined the same file. """ return commands - def getDateFormat(): """ getCommands(): This functions returns the command options used in the bot. These are defined the same file. """ return dateFormat - def getTimeFormat(): """ def getTimeFormat(): This functions returns the time format used in the bot. """ return timeFormat - def getMonthFormat(): """ def getMonthFormat(): This functions returns the month format used in the bot. """ return monthFormat - def getChoices(): return choices - def getBudgetOptions(): return budget_options - def getBudgetTypes(): return budget_types - def getUpdateOptions(): return update_options + +def getAnalyticsOptions(): + return analytics_options \ No newline at end of file diff --git a/code/history.py b/code/history.py index c52978512..30732c7a6 100644 --- a/code/history.py +++ b/code/history.py @@ -3,7 +3,6 @@ # === Documentation of history.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the delete feature. @@ -28,4 +27,4 @@ def run(message, bot): bot.send_message(chat_id, spend_total_str) except Exception as e: logging.exception(str(e)) - bot.reply_to(message, "Oops!" + str(e)) + bot.reply_to(message, "Oops!" + str(e)) \ No newline at end of file diff --git a/code/notifier.py b/code/notifier.py index 3ed207634..d968c504d 100644 --- a/code/notifier.py +++ b/code/notifier.py @@ -3,7 +3,6 @@ configs = Properties() - class TelegramNotifier: def __init__(self, token: str, parse_mode: str = None, chat_id: str = None): self._token = token @@ -46,4 +45,4 @@ def send(self, msg: str): f"Failed to send notification:\n\tstatus_code={response.status_code}\n\tjson:\n\t{response.json()}" ) except Exception as e: - print(f"Failed to send notification:\n\texception:\n\t{e}") + print(f"Failed to send notification:\n\texception:\n\t{e}") \ No newline at end of file diff --git a/code/notify.py b/code/notify.py index 391a092c0..36ed57e8f 100644 --- a/code/notify.py +++ b/code/notify.py @@ -3,7 +3,6 @@ configs = Properties() - def notify(chat_id, cat, amount): print("inside notify") with open("user.properties", "rb") as read_prop: @@ -12,4 +11,4 @@ def notify(chat_id, cat, amount): print(token) notifier = TelegramNotifier(token, parse_mode="HTML", chat_id=chat_id) msg = "Budget for " + cat + " exceeded by $" + amount + " !!!!" - notifier.send(msg) + notifier.send(msg) \ No newline at end of file diff --git a/code/pdf.py b/code/pdf.py index 6996ad32f..bf8726580 100644 --- a/code/pdf.py +++ b/code/pdf.py @@ -1,10 +1,12 @@ import helper import logging from matplotlib import pyplot as plt +from fpdf import FPDF +import graphing +import os # === Documentation of pdf.py === - def run(message, bot): """ run(message, bot): This is the main function used to implement the pdf save feature. @@ -13,8 +15,8 @@ def run(message, bot): helper.read_json() chat_id = message.chat.id user_history = helper.getUserHistory(chat_id) - message = "Alright. I just created a pdf of your expense history!" - bot.send_message(chat_id, message) + msg = "Alright. I just created a pdf of your expense history!" + bot.send_message(chat_id, msg) fig = plt.figure() ax = fig.add_subplot(1, 1, 1) top = 0.8 @@ -30,9 +32,8 @@ def run(message, bot): ) for rec in user_history: date, category, amount = rec.split(",") - date, time = date.split(" ") print(date, category, amount) - rec_str = f"{amount}$ {category} expense on {date} at {time}" + rec_str = f"{amount}$ {category} expense on {date}" plt.text( 0, top, @@ -45,9 +46,51 @@ def run(message, bot): ) top -= 0.15 plt.axis("off") - plt.savefig("expense_history.pdf") + plt.savefig("expense_history.png") plt.close() - bot.send_document(chat_id, open("expense_history.pdf", "rb")) + + if helper.isCategoryBudgetAvailable(chat_id): + category_budget = {} + for cat in helper.spend_categories: + if helper.isCategoryBudgetByCategoryAvailable(chat_id, cat): + category_budget[cat] = helper.getCategoryBudgetByCategory(chat_id, cat) + graphing.overall_split(category_budget) + + category_spend = {} + for cat in helper.spend_categories: + spend = helper.calculate_total_spendings_for_cateogory_chat_id(chat_id,cat) + if spend != 0: + category_spend[cat] = spend + if category_spend != {}: + graphing.spend_wise_split(category_spend) + + if helper.isCategoryBudgetAvailable(chat_id): + category_spend_percent = {} + for cat in helper.spend_categories: + if helper.isCategoryBudgetByCategoryAvailable(chat_id, cat): + percent = helper.calculateRemainingCateogryBudgetPercent(chat_id, cat) + category_spend_percent[cat] = percent + graphing.remaining(category_spend_percent) + + if helper.getUserHistory(chat_id): + cat_spend_dict = helper.getUserHistoryDateExpense(chat_id) + graphing.time_series(cat_spend_dict) + + list_of_images = ["overall_split.png","spend_wise.png","remaining.png","time_series.png"] + pdf = FPDF() + pdf.add_page() + x_coord = 20 + y_coord = 30 + for image in list_of_images: + pdf.image(image,x=x_coord,y=y_coord,w=70,h=50) + x_coord += 80 + if x_coord > 100: + x_coord = 20 + y_coord += 60 + pdf.output("expense_report.pdf", "F") + bot.send_document(chat_id, open("expense_report.pdf", "rb")) + for image in list_of_images: + os.remove(image) except Exception as e: logging.exception(str(e)) - bot.reply_to(message, "Oops!" + str(e)) + bot.reply_to(message, "Oops!" + str(e)) \ No newline at end of file diff --git a/code/predict.py b/code/predict.py new file mode 100644 index 000000000..e002e7702 --- /dev/null +++ b/code/predict.py @@ -0,0 +1,95 @@ +import time +import helper +import logging +from datetime import datetime + +# === Documentation of predict.py === +""" +average expenses by max no. of days between expenes, extrapolate to one month +minimum 2 expenses in category to predict category wise +minimum 2 expenses overall to predict overall budget +factor in savings after extrapolation +""" + +def run(message, bot): + """ + run(message, bot): This is the main function used to implement the predict feature. + It takes 2 arguments for processing - message which is the message from the user, and + bot which is the telegram bot object from the main code.py function. + """ + helper.read_json() + chat_id = message.chat.id + history = helper.getUserHistory(chat_id) + if history is None or len(history) < 2: + bot.send_message( + chat_id, "Sorry, you do not have sufficient spending records to predict a future budget" + ) + else: + predict_total(message,bot) + +def predict_total(message, bot): + """ + estimate_total(message, bot): It takes 2 arguments for processing - message which is the message + from the user, and bot which is the telegram bot object from the run(message, bot): function in the + same file. This function loads the user's data using the helper file's getUserHistory(chat_id) method. + After this, depending on the option user has chosen on the UI, it calls the calculate_estimate(queryResult, + days_to_estimate): to process the queried data to return to the user after which it finally passes the data to + the UI for the user to view. + """ + try: + chat_id = message.chat.id + history = helper.getUserHistory(chat_id) + available_categories = helper.getAvailableCategories(history) + category_wise_history = helper.getCategoryWiseSpendings(available_categories,history) + bot.send_message(chat_id, "Hold on! Calculating...") + # show the bot "typing" (max. 5 secs) + bot.send_chat_action(chat_id, "typing") + time.sleep(0.5) + category_spendings = {} + for category in available_categories: + category_spendings[category] = predict_category_spending(category_wise_history[category]) + overall_spending = predict_overall_spending(chat_id,category_spendings) + bot.send_message(chat_id, "Your overall budget for next month can be: ${}".format(overall_spending)) + category_budgets = helper.getFormattedPredictions(category_spendings) + bot.send_message(chat_id,category_budgets) + except Exception as e: + logging.exception(str(e)) + bot.reply_to(message, str(e)) + +def predict_category_spending(category_history): + """ + predict_category_spending(history): Takes 1 arguments for processing - category_history + which is the record of all expenses from a category. It parses the history + and turns it into a form suitable for display on the UI by the user. + """ + if len(category_history) < 2: + return 'Not enough records to predict spendings' + total_spent = 0 + recorded_days = [] + for record in category_history: + total_spent += float(record.split(',')[2]) + date = datetime.strptime(record.split(',')[0].split(' ')[0], helper.getDateFormat()) + recorded_days.append(date) + first = min(recorded_days) + last = max(recorded_days) + day_difference = abs(int((last - first).days)) + 1 + avg_per_day = total_spent/day_difference + predicted_spending = avg_per_day * 30 + return round(predicted_spending,2) + +def predict_overall_spending(chat_id, category_wise_spending): + """ + predict_overall_spending(chat_id, category_wise_spending): Takes 2 arguments for processing + chatId and category_wise_spending. It parses the history + and turns it into a form suitable for display on the UI by the user. + """ + overall_spending = 0 + for category in category_wise_spending.keys(): + if type(category_wise_spending[category]) == float: + overall_spending += category_wise_spending[category] + if overall_spending != 0: + return overall_spending + else: + history = helper.getUserHistory(chat_id) + overall_spending = predict_category_spending(history) + return overall_spending \ No newline at end of file diff --git a/docs/DollarBot_Marketing.mp4 b/docs/DollarBot_Marketing.mp4 new file mode 100644 index 000000000..33d96c8cf Binary files /dev/null and b/docs/DollarBot_Marketing.mp4 differ diff --git a/docs/Proj3-selfassessment.md b/docs/Proj3-selfassessment.md deleted file mode 100644 index 14fa90013..000000000 --- a/docs/Proj3-selfassessment.md +++ /dev/null @@ -1,26 +0,0 @@ -|Score | Notes | Evidence | -|-----|------|------| -|.5 | Short release cycles| Commits on multiple days over time from start to the beginning of project [Traffic](https://github.com/usmanwardag/dollar_bot/graphs/traffic)| -|.5 | Workload is spread over the whole team | Each member worked on a different [feature](https://github.com/usmanwardag/dollar_bot/issues) | -|.5 | Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing | [ReadMe.md](https://github.com/usmanwardag/dollar_bot/blob/main/README.md)| -|.5 | File CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up| Guidelines in [Contributing.md](https://github.com/usmanwardag/dollar_bot/blob/main/CONTRIBUTING.md) | -|.5 | Docs: doco generated , format not ugly| [docs](https://github.com/usmanwardag/dollar_bot/tree/main/docs)| -|.5 | evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people) |[Requirement.txt](https://github.com/usmanwardag/dollar_bot/blob/main/requirements.txt) | -|.5 | evidence that the members of the team are working across multiple places in the code base| Refer [Contributors](https://github.com/usmanwardag/dollar_bot/graphs/contributors)| -|1 | Docs: what: point descriptions of each class/function (in isolation)| [docs](https://github.com/usmanwardag/dollar_bot/tree/main/docs)| -|.5 | Number of commits: by different people| [Commit_activity](https://github.com/usmanwardag/dollar_bot/graphs/commit-activity) | -|1 | issues are being closed| [Closed_Issues](https://github.com/usmanwardag/dollar_bot/issues?q=is%3Aissue+is%3Aclosed) | -|.5 | issues are discussed before they are closed| Each issue updated with the discussion before closing and comments added -> https://github.com/usmanwardag/dollar_bot/issues| -|.5 | Use of syntax checkers.|Python compiler + VS Code Syntax highlighting | -|1 | Issues reports: |https://github.com/sak007/MyDollarBot-BOTGo/issues | -|.5 | Use of code formatters.| config files in GH showing your this formatter's config| Use of Flake8, updated in travis.yml -> https://github.com/sak007/MyDollarBot-BOTGo/blob/main/.travis.yml | -|.5 | Use of style checkers config files in GH showing your config|Use of Flake8 | -|.5 | Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.|[Youtube Video Link](https://www.youtube.com/watch?v=aCjcT1CHAzU)| -|.5 | Test cases exist | [121 test cases](https://github.com/usmanwardag/dollar_bot/tree/main/test)| -|.5 | Use of code coverage |https://app.codecov.io/gh/usmanwardag/dollar_bot | -|.5 | other automated analysis tools |https://app.travis-ci.com/github/usmanwardag/dollar_bot | -|.5 | Test cases:.a large proportion of the issues related to handling failing cases. (if a test case fails, open an issue and fix it| https://github.com/usmanwardag/dollar_bot/tree/main/test| -|.5 | Test cases are routinely executed | https://app.travis-ci.com/github/usmanwardag/dollar_bot| -|1 | Documentation describing how this version improves on the older version|[Updated_version](/home/aakriti/Desktop/project3/dollar_bot/docs/Proj3-selfassessment.md) | -|3 | This version is a little(1), some(2), much(3) improved on the last version. | Tutor's assessment | -|16 | Total | | diff --git a/docs/add.md b/docs/add.md index 118589551..232830ba5 100644 --- a/docs/add.md +++ b/docs/add.md @@ -10,43 +10,35 @@ Currently we have the following expense categories set by default: - Miscellaneous The user can choose a category and add the amount they have spent to be stored in the expense tracker. +The user can also choose to add their own category and record an expense for that category. +The user has the option to repeat any previously recorded expense (recurring expenses such as rent, utilities, etc.) # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/add.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/add.py) # Code Description ## Functions 1. run(message, bot): -This is the main function used to implement the add feature. It pop ups a menu on the bot asking the user to choose their expense category, after which control is given to post_category_selection(message, bot) for further proccessing. It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the main code.py function. +This is the main function used to implement the add feature. It gives the user the option to repeat a previously recorded expense, or record a new one. It pops up a menu on the bot asking the user to choose their expense category, after which control is given to post_category_selection(message, bot) for further proccessing. It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the main code.py function. 2. post_category_selection(message, bot): - It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the run(message, bot): function in the add.py file. It requests the user to enter the amount they have spent on the expense category chosen and then passes control to post_amount_input(message, bot): for further processing. +It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the run(message, bot): function in the add.py file. If the user wants to add a new category, passes control to post_append_spend(message,bot): to update the categories. Otherwise, it requests the user to enter the amount they have spent on the expense category chosen and then passes control to post_amount_input(message, bot): for further processing. -3. post_amount_input(message, bot): - It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the post_category_selection(message, bot): function in the add.py file. It takes the amount entered by the user, validates it with helper.validate() and then calls add_user_record to store it. +3. post_append_spend(message,bot): +This function adds the user defined category to the list of options available to record expenses, and then asks the user to pick the category for which they want to record an expense. The control passes back to post_category_selection(message, bot) once the user has selected the category to add an expense. -4. add_user_record(chat_id, record_to_be_added): - Takes 2 arguments - **chat_id** or the chat_id of the user's chat, and **record_to_be_added** which is the expense record to be added to the store. It then stores this expense record in the store. - -# How to run this feature? -Once the project is running(please follow the instructions given in the main README.md for this), please type /add into the telegram bot. - -Below you can see an example in text format: +4. record_expense(message, bot, previous_expenses): +This function takes **previous expenses** as an argument, which is the list of previously recorded expenses that users can choose to repeat. After the user selects the expense they want to repeat, it calls post_expense_selection(message,bot): to update and store the information. -dollarbot, [19.10.21 21:14] -[In reply to Sri Athithya Kruth] -Select Category +5. post_expense_selection(message,bot): +This function is called to record the previously recorded expense with the date updated to the current date. -Sri Athithya Kruth, [19.10.21 21:14] -Food +6. post_amount_input(message, bot): +It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the post_category_selection(message, bot): function in the add.py file. It takes the amount entered by the user, validates it with helper.validate() and then calls add_user_record to store it. -dollarbot, [19.10.21 21:14] -How much did you spend on Food? -(Enter numeric values only) - -Sri Athithya Kruth, [19.10.21 21:14] -1212 +7. add_user_record(chat_id, record_to_be_added): + Takes 2 arguments - **chat_id** or the chat_id of the user's chat, and **record_to_be_added** which is the expense record to be added to the store. It then stores this expense record in the store. -dollarbot, [19.10.21 21:14] -The following expenditure has been recorded: You have spent $1212.0 for Food on 19-Oct-2021 21:14 +# How to run this feature? +Once the project is running(please follow the instructions given in the main README.md for this), please type /add into the telegram bot. diff --git a/docs/analytics.md b/docs/analytics.md new file mode 100644 index 000000000..a5e956fd7 --- /dev/null +++ b/docs/analytics.md @@ -0,0 +1,25 @@ +# About DollarBot's /analytics Feature +This feature allows users to view graphical insights about their budgeting and expenses. + +There are four types of graphs that can be viewed. +1. View split of the overall budget category-wise +2. View split of current spending category-wise +3. View the remaining budget category-wise +4. View a time-series plot of the spending history + +# Location of Code for this Feature +The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/analytics.py) + +# Code Description +## Functions + +1. run(message, bot): +This is the main function used to implement the analytics feature. It pop ups a menu on the bot asking the user to choose type of analysis to display after which control is given to post_operation_selection(message, bot) for further proccessing. It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the main code.py function. + +2. post_operation_selection(message, bot): +It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the run(message, bot): function in the analytics.py file. Depending on the action chosen by the user, it passes on control to the corresponding functions which are all located in different files. + +[Learn about the graph implementation here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/docs/graphing.md) + +# How to run this feature? +Once the project is running(please follow the instructions given in the main README.md for this), please type /analytics into the telegram bot. diff --git a/docs/budget.md b/docs/budget.md index 0aa356a45..75267af27 100644 --- a/docs/budget.md +++ b/docs/budget.md @@ -4,7 +4,7 @@ This feature enables the user to add, remove, edit or display a budget in their The user can choose a category and add the amount for the budget to be stored in the expense tracker. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/budget.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/budget.py) # Code Description ## Functions diff --git a/docs/budget_delete.md b/docs/budget_delete.md index f8843532f..988d47b6e 100644 --- a/docs/budget_delete.md +++ b/docs/budget_delete.md @@ -2,7 +2,7 @@ The budget_view module contains all the functions required to implement the display delete/removal feature. In essence, all operations involved in removal and deletion of a budget are taken care of in this module and are implemented here. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/budget_delete.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/budget_delete.py) # Code Description ## Functions diff --git a/docs/budget_update.md b/docs/budget_update.md index f41316847..02f2a8745 100644 --- a/docs/budget_update.md +++ b/docs/budget_update.md @@ -2,7 +2,7 @@ The budget_view module contains all the functions required to implement the display add and update features. In essence, all operations involved in addition of a new budget and updating an existing budget are taken care of in this module and are implemented here. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/budget_update.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/budget_update.py) # Code Description ## Functions @@ -45,4 +45,4 @@ It takes the category chosen by the user from the message object. If the message Otherwise, it exits the feature. # How to run this feature? -Once the project is running(please follow the instructions given in the main README.md for this), please type /budget into the telegram bot. Please follow the prompts on the screen to create a new budget. \ No newline at end of file +Once the project is running(please follow the instructions given in the main README.md for this), please type /budget into the telegram bot. Please follow the prompts on the screen to create a new budget. diff --git a/docs/code.md b/docs/code.md index 096a6524c..3b9a28146 100644 --- a/docs/code.md +++ b/docs/code.md @@ -2,7 +2,7 @@ code.py is the main file from where calls to the corresponding .py files for all features are sent. It contains a number of endpoints which redirect to function calls in the corresponding files. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/code.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/code.py) # Code Description ## Functions @@ -13,23 +13,41 @@ The entire bot's execution begins here. It ensure the **bot** variable begins po 2. listener(user_requests): Takes 1 argument **user_requests** and logs all user interaction with the bot including all bot commands run and any other issue logs. -3. start_and_menu_command(m): +3. faq(m): +Prints out the frequently asked questions for users to understand some common doubts. Commands used to run this: command=['faq'] + +4. help(m): +Provides a succinct list of commands the user can use. Command used to run this: command=['help'] + +5. start_and_menu_command(m): Prints out the the main menu displaying the features that the bot offers and the corresponding commands to be run from the Telegram UI to use these features. Commands used to run this: commands=['start', 'menu'] -4. command_add(message) -Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls add.py to run to execute the add functionality. Commands used to run this: commands=['add'] +6. command_add(message) +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls add.py to run the add functionality. Commands used to run this: command=['add'] + +7. command_history(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls history.py to execute the history functionality. Commands used to run this: command=['history'] + +8. command_pdf(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls pdf.py to run to execute the pdf functionality. Commands used to run this: command=['pdf'] + +9. command_analytics(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls analytics.py which leverages get_analysis.py and graphing.py to perform the analytics. Commands used to run this: command=['analytics'] + +10. command_edit(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls edit.py to run the edit functionality. Commands used to run this: command=['edit'] -5. command_history(message): -Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls history.py to run to execute the add functionality. Commands used to run this: commands=['history'] +11. command_budget(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls budget.py to execute the budget functionality. Commands used to run this: command=['budget'] -6. command_edit(message): -Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls edit.py to run to execute the add functionality. Commands used to run this: commands=['edit'] +12. command_predict(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls predict.py to execute the predict functionality. Commands used to run this: command=['predict'] -7. command_display(message): -Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls display.py to run to execute the add functionality. Commands used to run this: commands=['display'] +13. command_display(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls display.py to run to execute the add functionality. Commands used to run this: command=['display'] -8. command_delete(message): -Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls delete.py to run to execute the add functionality. Commands used to run this: commands=['display'] +14. command_delete(message): +Takes 1 argument **message** which contains the message from the user along with the chat ID of the user chat. It then calls delete.py to run to execute the add functionality. Commands used to run this: command=['display'] # How to run this feature? -This file contains information on the main code.py file from where all features are run. Instructions to run this are the same as instructions to run the project and can be found in README.md. \ No newline at end of file +This file contains information on the main code.py file from where all features are run. Instructions to run this are the same as instructions to run the project and can be found in README.md. diff --git a/docs/delete.md b/docs/delete.md index 7506c2f0e..7289973ea 100644 --- a/docs/delete.md +++ b/docs/delete.md @@ -2,7 +2,7 @@ This feature enables the user to delete all of their saved records till date in their expense tracker. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/delete.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/delete.py) # Code Description ## Functions @@ -15,11 +15,3 @@ It takes 1 argument for processing - **chat_id** which is the chat_id of the use # How to run this feature? Once the project is running(please follow the instructions given in the main README.md for this), please type /add into the telegram bot. - -Below you can see an example in text format: - -Sri Athithya Kruth, [19.10.21 21:50] -/delete - -dollarbot,[] -History has been deleted! \ No newline at end of file diff --git a/docs/display.md b/docs/display.md index 0867121fb..14a918bea 100644 --- a/docs/display.md +++ b/docs/display.md @@ -2,7 +2,7 @@ This feature enables the user to view their expenses for the past month or past day. The option to choose month or day pops up on the screen and they can choose their preference to be displayed afterwards. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/display.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/display.py) # Code Description ## Functions @@ -18,25 +18,4 @@ It takes 2 arguments for processing - **message** which is the message from the 3. calculate_spendings(queryResult): Takes 1 argument for processing - **queryResult** which is the query result from the display total function in the same file. It parses the query result and turns it into a form suitable for display on the UI by the user. -# How to run this feature? -Sri Athithya Kruth, [20.10.21 20:33] -/display - -mydollarbot20102021, [20.10.21 20:33] -[In reply to Sri Athithya Kruth] -Please select a category to see the total expense - -Sri Athithya Kruth, [20.10.21 20:33] -Day - -mydollarbot20102021, [20.10.21 20:33] -Hold on! Calculating... - -mydollarbot20102021, [20.10.21 20:33] - -Here are your total spendings day: - -CATEGORIES,AMOUNT ----------------------- -Transport $1022.0 -Groceries $12.0 +# How to run this feature? \ No newline at end of file diff --git a/docs/dollar_bot/**/*.html b/docs/dollar_bot/**/*.html deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/dollar_bot/code/*.html b/docs/dollar_bot/code/*.html deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/edit.md b/docs/edit.md index ecdf8f81d..e1d9e7114 100644 --- a/docs/edit.md +++ b/docs/edit.md @@ -4,7 +4,7 @@ This feature enables the user to edit a previously entered expense in the app. T Please note that this is still a Work In Progress. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/edit.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/edit.py) # Code Description ## Functions @@ -12,22 +12,23 @@ The code that implements this feature can be found [here](https://github.com/sak 1. run(message, bot): This is the main function used to implement the delete feature. It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the main code.py function. It gets the details for the expense to be edited from here and passes control onto edit2(m, bot): for further processing. -2. edit2(message, bot): -It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the run(message, bot): function in the same file. It validates the date provided by the user to see if it's been correctly entered. If not, it throws an error stating the date is incorrect. If the date is correct, it then asks the user what they would like to edit for the expense in question, passing on to def edit3(m, bot): for further processing. +2. select_category_to_be_updated(m, bot): +It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the run(message, bot): function in the same file. It provides the user with the list of categories that they can update in the expense such as date, amount, category. Once the user selects the field that they want to update, control passes to enter_updated_data(m, bot, selected_data, updated): for further processing. -3. def edit3(message, bot): -It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the edit2(m, bot):: function in the same file. Based on the category chosen for editing by the user, it redirects to the corresponding function for further processing. +3. enter_updated_data(m, bot, selected_data, updated): +It takes 4 arguments for processing - **message** which is the message from the user, **bot** which is the telegram bot object from the select_category_to_be_updated(m, bot): function in the same file, **selected_data**, which is the expense that is being updated, and **updated**, which keeps track of the categories that have been updated so far. Based on the category chosen for editing by the user, it redirects to the corresponding function for further processing. -4. def edit_date(m, bot): -It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the edit3(m, bot):: function in the same file. It takes care of date change and edits. +4. edit_date(bot, selected_data, result, c, updated): +It takes 5 arguments for processing - **bot** which is the telegram bot object from the enter_updated_data(m, bot,selected_data,updated): function in the same file, **selected_data**, which is the expense that is being updated, **result**, which is the user selected date from the interactive calendar, **c**, the calendar object callback function which has the data about the chat(simulates message), and **updated**, which keeps track of the categories that have been updated so far. It takes care of date change and edits. -5. def edit_cost(m, bot): -It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the edit3(m, bot):: function in the same file. It takes care of cost change and edits. +5. edit_cost(m, bot, selected_data, updated): +It takes 4 arguments for processing - **message** which is the message from the user, **bot** which is the telegram bot object from the enter_updated_data(m, bot,selected_data,updated):unction in the same file, **selected_data**, which is the expense that is being updated, and **updated**, which keeps track of the categories that have been updated so far. It takes care of cost change and edits. -6. def edit_cat(m, bot): -It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the edit3(m, bot):: function in the same file. It takes care of category change and edits. +6. edit_cat(m, bot, selected_data, updated): +It takes 4 arguments for processing - **message** which is the message from the user, **bot** which is the telegram bot object from the enter_updated_data(m, bot,selected_data,updated): function in the same file, **selected_data**, which is the expense that is being updated, and **updated**, which keeps track of the categories that have been updated so far. It takes care of category change and edits. + +7. update_different_category(m, bot, selected_data, updated): +It takes 4 arguments for processing - **message** which is the message from the user, **bot** which is the telegram bot object from the enter_updated_data(m, bot,selected_data,updated): function in the same file, **selected_data**, which is the expense that is being updated, and **updated**, which keeps track of the categories that have been updated so far. It allows the user to select from the categories that have not previously been edited and passes the control to enter_updated_data(m, bot, selected_data, updated) for further processing. # How to run this feature? -Sri Athithya Kruth, [20.10.21 20:33] -/edit -(WORK IN PROGRESS) +type /edit, then follow the instructions on the chat to continue \ No newline at end of file diff --git a/docs/estimate.md b/docs/estimate.md index 91640f902..41db49cab 100644 --- a/docs/estimate.md +++ b/docs/estimate.md @@ -2,7 +2,7 @@ This feature enables the user to estimate their expenses for the next month or next day. The option to choose next month or next day pops up on the screen and they can choose their preference to be displayed. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/estimate-feature/code/estimate.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/estimate.py) # Code Description ## Functions @@ -20,25 +20,4 @@ Takes 2 arguments for processing - **queryResult** which is the query result fro # How to run this feature? -``` -$: python code/code.py - -$: /start - -$: /estimate - -Please select the period to estimate: -$: Next day - -Hold on! Calculating... - -Here are your estimated spendings for the next day: -CATEGORIES,AMOUNT ----------------------- -Food $200.0 -Groceries $100.0 -``` - -![alt text](https://github.com/sak007/MyDollarBot-BOTGo/blob/estimate-feature/docs/estimate.png) - diff --git a/docs/estimate.png b/docs/estimate.png deleted file mode 100644 index 00e95af51..000000000 Binary files a/docs/estimate.png and /dev/null differ diff --git a/docs/expenses.jpeg b/docs/expenses.jpeg deleted file mode 100644 index 92fa215ab..000000000 Binary files a/docs/expenses.jpeg and /dev/null differ diff --git a/docs/graphing.md b/docs/graphing.md index 36ae40d9b..a2c75eac5 100644 --- a/docs/graphing.md +++ b/docs/graphing.md @@ -1,10 +1,10 @@ # About MyDollarBot's /display Feature's Graph module This feature enables the user to see their expense in a graphical format to enable better UX. -Currently, the /display command will provide the expenses as a message to the users via the bot. To better the UX, we decided to add the option to show the expenses in a Bar Graph. +Currently, the /display & /analytics commands can display graphs. Use /analytics for better formats. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/graphing.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/graphing.py) # Code Description ## Functions @@ -15,5 +15,20 @@ This is the main function used to implement the graphing part of display feature 2. addlabels(x, y): This function is used to add the labels to the graph. It takes the expense values and adds the values inside the bar graph for each expense type +3. viewBudget(data): +This function saves a pie chart with the cateogry-wise budget split + +4. overall_split(category_budget): +This function is the updated version of viewBudget + +5. spend_wise_split(category_spend): +This function saves a pie chart with the category wise split of expenditure + +6. remaining(category_spend_percent): +This function saves a bar graph with the cateogry-wise % of budget remaining + +7. time_series(cat_spend_dict): +This function saves a time series graph with history of spending + # How to run this feature? -After you've added sufficient input data, use the /display command and you can see the output in a pictorial representation. +After you've added sufficient input data, use the /display or /analytics command and you can see the output in a pictorial representation. diff --git a/docs/graphs.jpeg b/docs/graphs.jpeg new file mode 100644 index 000000000..39b3fa25e Binary files /dev/null and b/docs/graphs.jpeg differ diff --git a/docs/helper.md b/docs/helper.md index 54b993b7f..00cf99fe2 100644 --- a/docs/helper.md +++ b/docs/helper.md @@ -2,7 +2,7 @@ The helper file contains a set of functions that are commonly used for repeated tasks in the various features of MyDollarBot. Since these come up often, we have put them all up here in a separate file for reusability. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/helper.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/helper.py) # Code Description ## Functions @@ -19,25 +19,104 @@ Takes 1 argument, **amount_entered**. It validates this amount's format to see i 4. getUserHistory(chat_id): Takes 1 argument **chat_id** and uses this to get the relevant user's historical data. -5. getSpendCategories(): +4. getUserHistoryByCategory(chat_id,category): +Takes 2 arguments **chat_id** and **category** and returns the expenses from a specific category for a given chat id. + +5. getUserData(chat_id): +This function gives all the data related to a user from the chat_id. Includes budgets and expenses. + +6. throw_exception(e, message, bot, logging): +Used for error handling in bot code. Throws exception if any is thrown by another part of code. + +7. createNewUserRecord(): +Creates a new record for a newly registered user + +8. getOverallBudget(chatId): +Returns overall budget value for given user + +9. getCategoryBudget(chatId): +Returns category-wise budget split for given user + +10. getCategoryBudgetByCategory(chatId, cat): +Returns specific category's budget allocation + +11. isOverallBudgetAvailable(chatId): +Checks whether overall budget is initialized or not + +12. isCategoryBudgetAvailable(chatId): +Checks whether category wise budget is initialized or not + +13. isCategoryBudgetByCategoryAvailable(chatId, cat): +Checks whether specified category's budget is initialized or not + +14. get_uncategorized_amount(chatId, amount): +Calculates the portion of the budget that is not assigned to any specific category + +15. display_remaining_budget(message, bot, cat): +Displays remaining budget + +16. display_remaining_overall_budget(message, bot): +Displays overall budget after recorded expenses + +17. calculateRemainingOverallBudget(chat_id): +Calculate remaining overall budget after recorded expenses + +18. calculate_total_spendings(queryResult): +Calculate total spendings of the user + +19. display_remaining_category_budget(message, bot, cat): +Display remaining category budget for a specific category + +20. calculateRemainingCategoryBudget(chat_id, cat): +Calculate remaining category budget after recorded expenses in the specific category + +21. calculateRemainingCateogryBudgetPercent(chat_id, cat): +Calculate percentage of spent money on a particular category against its budget. + +22. calculate_total_spendings_for_category(queryResult, cat): +Calculate total spending of the user within a specific category + +23. updateBudgetCategory(chatId, category): +initializes the specific budget category + +24. getAvailableCategories(history): +Get available categories from history data + +25. getCategoryWiseSpendings(available_categories, history): +Get category wise spending details + +26. getFormattedPredictions(category_predictions): +Format predictions into readable format from dictionary into string in order to send message to the user. + +27. getSpendCategories(): This functions returns the spend categories used in the bot. These are defined the same file. -6. getSpendDisplayOptions(): +28. getSpendDisplayOptions(): This functions returns the spend display options used in the bot. These are defined the same file. -7. getCommands(): +29. getCommands(): This functions returns the command options used in the bot. These are defined the same file. -8. def getDateFormat(): +30. def getDateFormat(): This functions returns the date format used in the bot. -9. def getTimeFormat(): +31. def getTimeFormat(): This functions returns the time format used in the bot. -10. def getMonthFormat(): +32. def getMonthFormat(): This functions returns the month format used in the bot. -# How to run this feature? -Once the project is running(please follow the instructions given in the main README.md for this), please type /add into the telegram bot. +33. getBudgetOptions(): +This function returns the budget options used by the bot. These are defined in the same file. + +34. getBudgetTypes(): +This function returns the types of budgets that can be set up by users. These are defined in the same file. +35. getUpdateOptions(): +This function returns the update options used by the bot. These are defined in the same file. + +36. getAnalyticsOptions(): +This function returns the analytics options used by the bot. These are defined in the same file. + +# How to run this feature? This file is not a feature and cannot be run per se. Its functions are used all over by the other files as it provides helper functions for various functionalities and features. \ No newline at end of file diff --git a/docs/history.md b/docs/history.md index c259a341a..bb30fbb1b 100644 --- a/docs/history.md +++ b/docs/history.md @@ -2,7 +2,7 @@ This feature enables the user to view all of their stored records i.e it gives a historical view of all the expenses stored in MyDollarBot. # Location of Code for this Feature -The code that implements this feature can be found [here](https://github.com/sak007/MyDollarBot-BOTGo/blob/main/code/history.py) +The code that implements this feature can be found [here](https://github.com/aditikilledar/dollar_bot_SE23/blob/main/code/history.py) # Code Description ## Functions @@ -11,25 +11,4 @@ The code that implements this feature can be found [here](https://github.com/sak This is the main function used to implement the delete feature. It takes 2 arguments for processing - **message** which is the message from the user, and **bot** which is the telegram bot object from the main code.py function. It calls helper.py to get the user's historical data and based on whether there is data available, it either prints an error message or displays the user's historical data. # How to run this feature? -Once the project is running(please follow the instructions given in the main README.md for this), please type /add into the telegram bot. - -Below you can see an example in text format: - -Sri Athithya Kruth, [20.10.21 20:33] -/display - -Sri Athithya Kruth, [20.10.21 20:33] -Day - -mydollarbot20102021, [20.10.21 20:33] -Hold on! Calculating... - -Sri Athithya Kruth, [20.10.21 20:53] -/history - -mydollarbot20102021, [20.10.21 20:53] -Here is your spending history : -DATE, CATEGORY, AMOUNT ----------------------- -20-Oct-2021 20:33,Transport,1022.0 -20-Oct-2021 20:33,Groceries,12.0 \ No newline at end of file +Once the project is running(please follow the instructions given in the main README.md for this), please type /history into the telegram bot. diff --git a/docs/proj1rubric.md b/docs/proj1rubric.md deleted file mode 100644 index a96b1a391..000000000 --- a/docs/proj1rubric.md +++ /dev/null @@ -1,223 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NotesSelf Assessment zero (none), one (a litte), two (somewhat), three (a lot)evidence
workload is spread over the whole team (one team member is often Xtimes more productive than the others...ThreeEvery team member has implemented a functionality in the bot, which can be seen via their respective GitHub commits
but nevertheless, here is a track record that everyone is contributing a lot)
Number of commitsThreeGitHub commits on 'main': https://github.com/deekay2310/MyDollarBot/commits/main
Number of commits: by different peopleThreeCommits by each team member: https://github.com/deekay2310/MyDollarBot/tree/dev, https://github.com/deekay2310/MyDollarBot/tree/prakruthi, https://github.com/deekay2310/MyDollarBot/tree/radhika, https://github.com/deekay2310/MyDollarBot/tree/rohan, https://github.com/deekay2310/MyDollarBot/tree/Sunidhi
Issues reports: there are many issues are being closedThreehttps://github.com/deekay2310/MyDollarBot/issues
Issues are being closedThreehttps://github.com/deekay2310/MyDollarBot/issues?q=is%3Aissue+is%3Aclosed
DOI badge: existsThreehttps://zenodo.org/record/5542548#.YVZIrtNue3I
Docs: doco generated , format not uglyThreehttps://github.com/deekay2310/MyDollarBot/tree/main/docs
Docs: what: point descriptions of each class/function (in isolation)Threehttps://github.com/deekay2310/MyDollarBot/blob/main/docs/functionDescription.md
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,ZThreehttps://github.com/deekay2310/MyDollarBot/blob/main/README.md
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thingThreehttps://github.com/deekay2310/MyDollarBot/blob/main/README.md
Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.Threehttps://github.com/deekay2310/MyDollarBot/blob/main/README.md
Use of version control tools
Use of style checkers
Use of code formatters
Use of syntax checkers.
Use of code coverage
other automated analysis tools
test cases exist
test cases are routinely executed
the files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things upThreehttps://github.com/deekay2310/MyDollarBot/blob/main/CONTRIBUTING.md
issues are discussed before they are closedThreeScheduled regular zoom meetings and met in person to discuss about various issues, implementations and tasks. Reviewed each other's changes before wrapping up issues. Had continuous discussions over team WhatsApp group as well.
Chat channel: existsThreeTeam specific WhatsApp group
test cases:.a large proportion of the issues related to handling failing cases
evidence that the whole team is using the same tools: everyone can get to all tools and filesThree
evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people)Three
evidence that the whole team is using the same tools (e.g. tutor can ask anyone to share screen, they demonstrate the system running on their computer)Three
evidence that the members of the team are working across multiple places in the code baseThree
short release cyclesThreeFrequent commits
- -| Question 1.1: Does your website and documentation provide a clear, high-level overview of your software? |Yes|
-| Question 1.2: Does your website and documentation clearly describe the type of user who should use your software? |Yes|
-| Question 1.3: Do you publish case studies to show how your software has been used by yourself and others? |Yes| -| Question 2.1: Is the name of your project/software unique? * |Yes| -| Question 2.2: Is your project/software name free from trademark violations? * |Yes| -| Question 3.1: Is your software available as a package that can be deployed without building it? |Yes| -| Question 3.2: Is your software available for free? |Yes| -| Question 3.3: Is your source code publicly available to download, either as a downloadable bundle or via access to a source code repository? |Yes| -| Question 3.4: Is your software hosted in an established, third-party repository likeGitHub (https://github.com), BitBucket (https://bitbucket.org),LaunchPad (https://launchpad.net) orSourceForge (https://sourceforge.net)? |Yes| -| Question 4.1: Is your documentation clearly available on your website or within your software? |Yes| -| Question 4.2: Does your documentation include a "quick start" guide, that provides a short overview of how to use your software with some basic examples of use? |Yes| -| Question 4.3: If you provide more extensive documentation, does this provide clear, step-by-step instructions on how to deploy and use your software? |Yes| -| Question 4.4: Do you provide a comprehensive guide to all your software’s commands, functions and options? * |Yes| -| Question 4.5: Do you provide troubleshooting information that describes the symptoms and step-by-step solutions for problems and error messages? * |No| -| Question 4.6: If your software can be used as a library, package or service by other software, do you provide comprehensive API documentation? * |No| -| Question 4.7: Do you store your documentation under revision control with your source code? * |No| -| Question 4.8: Do you publish your release history e.g. release data, version numbers, key features of each release etc. on your web site or in your documentation? * |Yes| -| Question 5.1: Does your software describe how a user can get help with using your software? * |No| -| Question 5.2: Does your website and documentation describe what support, if any, you provide to users and developers? * |No| -| Question 5.3: Does your project have an e-mail address or forum that is solely for supporting users? * |No| -| Question 5.4: Are e-mails to your support e-mail address received by more than one person? * |No| -| Question 5.5: Does your project have a ticketing system to manage bug reports and feature requests? * |No| -| Question 5.6: Is your project's ticketing system publicly visible to your users, so they can view bug reports and feature requests? * |No| -| Question 6.1: Is your software’s architecture and design modular? * |Yes| -| Question 6.2: Does your software use an accepted coding standard or convention? * |Yes| -| Question 7.1: Does your software allow data to be imported and exported using open data formats? * |Yes| -| Question 7.2: Does your software allow communications using open communications protocols? * |Yes| -| Question 8.1: Is your software cross-platform compatible? * |Yes| -| Question 9.1: Does your software adhere to appropriate accessibility conventions or standards? * |Yes| -| Question 9.2: Does your documentation adhere to appropriate accessibility conventions or standards? * |Yes| -| Question 10.1: Is your source code stored in a repository under revision control? * |No| -| Question 10.2: Is each source code release a snapshot of the repository? * |No| -| Question 10.3: Are releases tagged in the repository? * |Yes| -| Question 10.4: Is there a branch of the repository that is always stable? (i.e. tests always pass, code always builds successfully) * |Yes| -| Question 10.5: Do you back-up your repository? * |Yes| -| Question 11.1: Do you provide publicly-available instructions for building your software from the source code? * |Yes| -| Question 11.2: Can you build, or package, your software using an automated tool? * |Yes| -| Question 11.3: Do you provide publicly-available instructions for deploying your software? * |Yes| -| Question 11.4: Does your documentation list all third-party dependencies? * |Yes| -| Question 11.5: Does your documentation list the version number for all third-party dependencies? * |Yes| -| Question 11.6: Does your software list the web address, and licences for all third-party dependencies and say whether the dependencies are mandatory or optional? * |Yes| -| Question 11.7: Can you download dependencies using a dependency management tool or package manager? * |Yes| -| Question 11.8: Do you have tests that can be run after your software has been built or deployed to show whether the build or deployment has been successful? * |Yes| -| Question 12.1: Do you have an automated test suite for your software? * |Yes| -| Question 12.2: Do you have a framework to periodically (e.g. nightly) run your tests on the latest version of the source code? * |Yes| -| Question 12.3: Do you use continuous integration, automatically running tests whenever changes are made to your source code? * |Yes| -| Question 12.4: Are your test results publicly visible? * |Yes| -| Question 12.5: Are all manually-run tests documented? * |Yes| -| Question 13.1: Does your project have resources (e.g. blog, Twitter, RSS feed, Facebook page, wiki, mailing list) that are regularly updated with information about your software? * |No| -| Question 13.2: Does your website state how many projects and users are associated with your project? * |Yes| -| Question 13.3: Do you provide success stories on your website? * |No| -| Question 13.4: Do you list your important partners and collaborators on your website? * |Yes| -| Question 13.5: Do you list your project's publications on your website or link to a resource where these are available? * |No| -| Question 13.6: Do you list third-party publications that refer to your software on your website or link to a resource where these are available? * |No| -| Question 13.7: Can users subscribe to notifications to changes to your source code repository? * |No| -| Question 13.8: If your software is developed as an open source project (and, not just a project developing open source software), do you have a governance model? * |No| -| Question 14.1: Do you accept contributions (e.g. bug fixes, enhancements, documentation updates, tutorials) from people who are not part of your project? * |Yes| -| Question 14.2: Do you have a contributions policy? * |Yes| -| Question 14.3: Is your contributions' policy publicly available? * |Yes| -| Question 14.4: Do contributors keep the copyright/IP of their contributions? * |No| -| Question 15.1: Does your website and documentation clearly state the copyright owners of your software and documentation? * |No| -| Question 15.2: Does each of your source code files include a copyright statement? * |No| -| Question 15.3: Does your website and documentation clearly state the licence of your software? * |Yes| -| Question 15.4: Is your software released under an open source licence? * |Yes| -| Question 15.5: Is your software released under an OSI-approved open-source licence? * |Yes| -| Question 15.6: Does each of your source code files include a licence header? * |No| -| Question 15.7: Do you have a recommended citation for your software? * |Yes| -| Question 16.1: Does your website or documentation include a project roadmap (a list of project and development milestones for the next 3, 6 and 12 months)? * |Yes| -| Question 16.2: Does your website or documentation describe how your project is funded, and the period over which funding is guaranteed? * |No| -| Question 16.3: Do you make timely announcements of the deprecation of components, APIs, etc.? * |No| diff --git a/docs/whats-new.md b/docs/whats-new.md new file mode 100644 index 000000000..953f7ca42 --- /dev/null +++ b/docs/whats-new.md @@ -0,0 +1,47 @@ +# What's new in Dollar Bot? + +## Budget predictions: + +Tracks trends in spending and predicts an accurate budget based on past expenses. +Use /predict to try it out for yourself! + +## Improved command functionality: + +Ever wanted to edit the budget for multiple categories at once? + +Now it's possible! Giving you a seamless experience without the hassle of typing multiple commands! + +## Better PDF reports: + +PDF reports now are more informative with graphical as well as numerical data. +Generates a detailed expense report of your current expenses and budgets. + +Use /pdf to give it a go! + +## Recurring expenses: + +Now allows you to add subscriptions, rent etc as recurring expenses avoiding the effort to do it multiple times. + +Try it under /add + +## Analytics: + +### Now we have 4 types of graphs you can take a look at! +1. Category-wise budget split +2. Category-wise expense split +3. Percent of budget used vs available budget +4. Time series graph of expenses + +Here's your budget split by categories: +![pie chart](https://github.com/aditikilledar/dollar_bot_SE23/new/main/docs/graphs.jpeg?raw=true) + +Use /analytics to try it out! + +## Clean setup script: + +If you were looking to run dollarbot yourself, now you'll find the process much simpler. +Check it out for yourself! + +## Better documentation: + +Commands are more intuitive to use with better documentation of what they do. diff --git a/python_docs/__init__.html b/python_docs/__init__.html deleted file mode 100644 index 3881a4efb..000000000 --- a/python_docs/__init__.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - __init__.py - - - -
-
-
-

__init__.py

-
-
-
-
-
- # -
- -
-
- 
import os
-import sys
-sys.path.insert(0, os.getcwd() + "/code")
-
-
-
-
-
-
- diff --git a/python_docs/add.html b/python_docs/add.html deleted file mode 100644 index e7d49247c..000000000 --- a/python_docs/add.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - add.py - - - -
-
-
-

add.py

-
-
-
-
-
- # -
- -
-
- 
import helper
-import logging
-from telebot import types
-from datetime import datetime
-
-
-option = {}
-
-
-
-
-
-
- # -
-

Documentation of add.py

-
-
- 
def run(message, bot):
-
-
-
-
-
-
- # -
-

run(message, bot): This is the main function used to implement the add feature. -It pop ups a menu on the bot asking the user to choose their expense category, -after which control is given to post_category_selection(message, bot) for further proccessing. -It takes 2 arguments for processing - message which is the message from the user, -and bot which is the telegram bot object from the main code.py function.

-
-
- 
    helper.read_json()
-    chat_id = message.chat.id
-    option.pop(chat_id, None)  # remove temp choice
-    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    markup.row_width = 2
-    m= bot.send_message(chat_id, "Do you want to add a new categories? Y/N")
-    bot.register_next_step_handler(
-            m, post_user_def_category, bot)
-
-
-
-
-
-
- # -
-

user_input = m.text -print(m) -print(user_input) -if str(user_input)==”Y”: - print(“Hello”) - message1=bot.send_message(chat_id, “Please enter your category”) - selected_category=message1.text - helper.spend_categories.append(selected_category) - print(selected_category) - bot.register_next_step_handler(selected_category, post_category_selection, bot) -for c in helper.getSpendCategories(): - markup.add(c) -msg = bot.reply_to(message, ‘Select Category’, reply_markup=markup)

-

bot.register_next_step_handler(msg, post_category_selection, bot)

-
-
- 
def post_user_def_category(message,bot):
-    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    markup.row_width = 2
-    print(message.text)
-    chat_id = message.chat.id
-    if str(message.text)=="Y":
-        message1=bot.send_message(chat_id, "Please enter your category")
-        bot.register_next_step_handler(message1,post_append_spend, bot)
-    else:
-        for c in helper.getSpendCategories():
-            markup.add(c)
-        msg = bot.reply_to(message, 'Select Category', reply_markup=markup)
-    
-        bot.register_next_step_handler(msg, post_category_selection, bot)
-
-
-
-
-
-
- # -
- -
-
- 
def post_append_spend(message,bot):
-    print(message.text)  
-    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    markup.row_width = 2
-    selected_category=message.text
-    helper.spend_categories.append(selected_category) 
-    print(helper.spend_categories)   
-    for c in helper.getSpendCategories():
-        markup.add(c)
-    msg = bot.reply_to(message, 'Select Category', reply_markup=markup)
-    
-    bot.register_next_step_handler(msg, post_category_selection, bot)
-
-
-
-
-
-
- # -
-

post_category_selection(message, bot): It takes 2 arguments for processing - -message which is the message from the user, and bot which is the telegram bot object -from the run(message, bot): function in the add.py file. It requests the user to enter the amount -they have spent on the expense category chosen and then passes control to -post_amount_input(message, bot): for further processing.

-
-
- 
def post_category_selection(message, bot):
-
-
-
-
-
-
- # -
- -
-
- 
    try:
-        chat_id = message.chat.id
-        selected_category = message.text
-        if selected_category not in helper.getSpendCategories():
-            bot.send_message(chat_id, 'Invalid',
-                             reply_markup=types.ReplyKeyboardRemove())
-            raise Exception(
-                "Sorry I don't recognise this category \"{}\"!".format(selected_category))
-
-        option[chat_id] = selected_category
-        message = bot.send_message(
-            chat_id, 'How much did you spend on {}? \n(Enter numeric values only)'.format(str(option[chat_id])))
-        print(message)
-        bot.register_next_step_handler(
-            message, post_amount_input, bot, selected_category)
-    except Exception as e:
-        logging.exception(str(e))
-        bot.reply_to(message, 'Oh no! ' + str(e))
-        display_text = ""
-        commands = helper.getCommands()
-        for c in commands:  # generate help text out of the commands dictionary defined at the top
-            display_text += "/" + c + ": "
-            display_text += commands[c] + "\n"
-        bot.send_message(chat_id, 'Please select a menu option from below:')
-        bot.send_message(chat_id, display_text)
-
-
-
-
-
-
- # -
-

post_amount_input(message, bot): It takes 2 arguments for processing - -message which is the message from the user, and bot which is the telegram bot -object from the post_category_selection(message, bot): function in the add.py file. -It takes the amount entered by the user, validates it with helper.validate() and then -calls add_user_record to store it.

-
-
- 
def post_amount_input(message, bot, selected_category):
-
-
-
-
-
-
- # -
- -
-
- 
    try:
-        print("---------------------------------------------------")
-
-        chat_id = message.chat.id
-        print(chat_id)
-        amount_entered = message.text
-        print("0000000000000000000000000000000000000000000000000")
-        print(amount_entered)
-        print(selected_category)
-        amount_value = helper.validate_entered_amount(
-            amount_entered)  # validate
-        if amount_value == 0:  # cannot be $0 spending
-            raise Exception("Spent amount has to be a non-zero number.")
-
-        date_of_entry = datetime.today().strftime(
-            helper.getDateFormat() + ' ' + helper.getTimeFormat())
-
-        date_str, category_str, amount_str = str(
-            date_of_entry), str(option[chat_id]), str(amount_value)
-
-        helper.write_json(add_user_record(
-            chat_id, "{},{},{}".format(date_str, category_str, amount_str)))
-
-        bot.send_message(chat_id, 'The following expenditure has been recorded: You have spent ${} for {} on {}'.format(
-            amount_str, category_str, date_str))
-
-        helper.display_remaining_budget(message, bot, selected_category)
-    except Exception as e:
-        logging.exception(str(e))
-        bot.reply_to(message, 'Oh no. ' + str(e))
-
-
-
-
-
-
- # -
-

add_user_record(chat_id, record_to_be_added): Takes 2 arguments - -chat_id or the chat_id of the user’s chat, and record_to_be_added which -is the expense record to be added to the store. It then stores this expense record in the store.

-
-
- 
def add_user_record(chat_id, record_to_be_added):
-
-
-
-
-
-
- # -
- -
-
- 
    user_list = helper.read_json()
-    print('!'*5)
-    print('before')
-    print(user_list)
-    print('!'*5)
-    if str(chat_id) not in user_list:
-        user_list[str(chat_id)] = helper.createNewUserRecord()
-
-    user_list[str(chat_id)]['data'].append(record_to_be_added)
-
-    print('!'*5)
-    print('after')
-    print(user_list)
-    print('!'*5)
-    return user_list
-
-
-
-
-
-
- diff --git a/python_docs/budget.html b/python_docs/budget.html deleted file mode 100644 index 74f008b77..000000000 --- a/python_docs/budget.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - budget.py - - - -
-
-
-

budget.py

-
-
-
-
-
- # -
- -
-
- 
import helper
-import budget_view
-import budget_update
-import budget_delete
-import logging
-from telebot import types
-
-
-
-
-
-
- # -
-

Documentation of budget.py

-
-
- 

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the budget feature. 
-It pop ups a menu on the bot asking the user to choose to add, remove or display a budget, 
-after which control is given to post_operation_selection(message, bot) for further proccessing. 
-It takes 2 arguments for processing - message which is the message from the user, and bot which is the 
-telegram bot object from the main code.py function.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    options = helper.getBudgetOptions()
-    markup.row_width = 2
-    for c in options.values():
-        markup.add(c)
-    msg = bot.reply_to(message, 'Select Operation', reply_markup=markup)
-    bot.register_next_step_handler(msg, post_operation_selection, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
post_operation_selection(message, bot): It takes 2 arguments for processing - message which 
-is the message from the user, and bot which is the telegram bot object from the 
-run(message, bot): function in the budget.py file. Depending on the action chosen by the user, 
-it passes on control to the corresponding functions which are all located in different files.

-    

-    

-      
def post_operation_selection(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        op = message.text
-        options = helper.getBudgetOptions()
-        if op not in options.values():
-            bot.send_message(chat_id, 'Invalid',
-                             reply_markup=types.ReplyKeyboardRemove())
-            raise Exception(
-                "Sorry I don't recognise this operation \"{}\"!".format(op))
-        if op == options['update']:
-            budget_update.run(message, bot)
-        elif op == options['view']:
-            budget_view.run(message, bot)
-        elif op == options['delete']:
-            budget_delete.run(message, bot)
-    except Exception as e:

-    

-  

-  

-  

-    

-      

-        #
-      

-      
print(“hit exception”)

-    

-    

-      
        helper.throw_exception(e, message, bot, logging)
-
-

-    

-  

-  

-

-
diff --git a/python_docs/budget_delete.html b/python_docs/budget_delete.html
deleted file mode 100644
index 0ee05e3db..000000000
--- a/python_docs/budget_delete.html
+++ /dev/null
@@ -1,78 +0,0 @@
-
-
-
-  
-  budget_delete.py
-  
-
-
-

-  

-  

-    
budget_delete.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import helper

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of budget_delete.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the budget delete feature. 
-It takes 2 arguments for processing - message which is the message from the user, and bot 
-which is the telegram bot object from the main code.py function. It gets the user’s chat ID 
-from the message object, and reads all user data through the read_json method from the helper module. 
-It then proceeds to empty the budget data for the particular user based on the user ID provided from the UI. 
-It returns a simple message indicating that this operation has been done to the UI.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    chat_id = message.chat.id
-    user_list = helper.read_json()
-    print(user_list)
-    if str(chat_id) in user_list:
-        user_list[str(chat_id)]['budget']['overall'] = None
-        user_list[str(chat_id)]['budget']['category'] = None
-        helper.write_json(user_list)
-    bot.send_message(chat_id, 'Budget deleted!')
-
-

-    

-  

-  

-

-
diff --git a/python_docs/budget_update.html b/python_docs/budget_update.html
deleted file mode 100644
index e255f270e..000000000
--- a/python_docs/budget_update.html
+++ /dev/null
@@ -1,397 +0,0 @@
-
-
-
-  
-  budget_update.py
-  
-
-
-

-  

-  

-    
budget_update.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import helper
-import logging
-from telebot import types

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of budget_update.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the budget add/update features. 
-It takes 2 arguments for processing - message which is the message from the user, and bot which 
-is the telegram bot object from the main code.py function.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    chat_id = message.chat.id
-    if helper.isOverallBudgetAvailable(chat_id):
-        update_overall_budget(chat_id, bot)
-    elif helper.isCategoryBudgetAvailable(chat_id):
-        update_category_budget(message, bot)
-    else:
-        markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-        options = helper.getBudgetTypes()
-        markup.row_width = 2
-        for c in options.values():
-            markup.add(c)
-        msg = bot.reply_to(message, 'Select Budget Type', reply_markup=markup)
-        bot.register_next_step_handler(msg, post_type_selection, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
post_type_selection(message, bot): It takes 2 arguments for processing - message 
-which is the message from the user, and bot which is the telegram bot object. 
-This function takes input from the user, making them choose which type of budget they 
-would like to create - category-wise or overall, and then calls the corresponding functions for further processing.

-    

-    

-      
def post_type_selection(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        op = message.text
-        options = helper.getBudgetTypes()
-        if op not in options.values():
-            bot.send_message(chat_id, 'Invalid',
-                             reply_markup=types.ReplyKeyboardRemove())
-            raise Exception(
-                "Sorry I don't recognise this operation \"{}\"!".format(op))
-        if op == options['overall']:
-            update_overall_budget(chat_id, bot)
-        elif op == options['category']:
-            update_category_budget(message, bot)
-    except Exception as e:
-        helper.throw_exception(e, message, bot, logging)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
update_overall_budget(message, bot): It takes 2 arguments for processing - message which is the 
-message from the user, and bot which is the telegram bot object. This function is called when the 
-user wants to either create a new overall budget or update an existing one. It checks if there is an 
-existing budget through the helper module’s isOverallBudgetAvailable function and if so, displays this 
-along with the prompt for the new (to be updated) budget, or just asks for the new budget. It passes control 
-to the post_overall_amount_input function in the same file.

-    

-    

-      
def update_overall_budget(chat_id, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    if (helper.isOverallBudgetAvailable(chat_id)):
-        currentBudget = helper.getOverallBudget(chat_id)
-        msg_string = 'Current Budget is ${}\n\nHow much is your new monthly budget? \n(Enter numeric values only)'
-        message = bot.send_message(chat_id, msg_string.format(currentBudget))
-    else:
-        message = bot.send_message(
-            chat_id, 'How much is your monthly budget? \n(Enter numeric values only)')
-    bot.register_next_step_handler(message, post_overall_amount_input, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
update_overall_budget(message, bot): It takes 2 arguments for processing - 
-message which is the message from the user, and bot which is the telegram bot object. 
-This function is called when the user wants to either create a new overall budget or 
-update an existing one. It checks if there is an existing budget through the helper module’s 
-isOverallBudgetAvailable function and if so, displays this along with the prompt for the new 
-(to be updated) budget, or just asks for the new budget. It passes control to the post_overall_amount_input 
-function in the same file.

-    

-    

-      
def post_overall_amount_input(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        amount_value = helper.validate_entered_amount(message.text)
-        if amount_value == 0:
-            raise Exception("Invalid amount.")
-        user_list = helper.read_json()
-        if str(chat_id) not in user_list:
-            user_list[str(chat_id)] = helper.createNewUserRecord()
-        user_list[str(chat_id)]['budget']['overall'] = amount_value
-        helper.write_json(user_list)
-        bot.send_message(chat_id, 'Budget Updated!')
-        return user_list
-    except Exception as e:
-        helper.throw_exception(e, message, bot, logging)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
update_category_budget(message, bot): It takes 2 arguments for processing -
-message which is the message from the user, and bot which is the telegram bot object. 
-This function is called in case the user decides to choose category-wise budgest in the run or 
-post_type_selection stages. It gets the spend categories from the helper module’s getSpendCategories 
-and displays them to the user. It then passes control on to the post_category_selection function.

-    

-    

-      
def update_category_budget(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    categories = helper.getSpendCategories()
-    markup.row_width = 2
-    for c in categories:
-        markup.add(c)
-    msg = bot.reply_to(message, 'Select Category', reply_markup=markup)
-    bot.register_next_step_handler(msg, post_category_selection, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
post_category_selection(message, bot): It takes 2 arguments for processing - 
-message which is the message from the user, and bot which is the telegram bot object. 
-Based on the category chosen by the user, the bot checks if these are part of the pre-defined 
-categories in helper.getSpendCategories(), else it throws an exception. If there is a budget 
-already existing for the category, it identifies this case through helper.isCategoryBudgetByCategoryAvailable 
-and shares this information with the user. If not, it simply proceeds. In either case, it then asks for the 
-new/updated budget amount. It passes control onto post_category_amount_input.

-    

-    

-      
def post_category_selection(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        selected_category = message.text
-        categories = helper.getSpendCategories()
-        if selected_category not in categories:
-            bot.send_message(chat_id, 'Invalid',
-                             reply_markup=types.ReplyKeyboardRemove())
-            raise Exception(
-                "Sorry I don't recognise this category \"{}\"!".format(selected_category))
-        if helper.isCategoryBudgetByCategoryAvailable(chat_id, selected_category):
-            currentBudget = helper.getCategoryBudgetByCategory(
-                chat_id, selected_category)
-            msg_string = 'Current monthly budget for {} is {}\n\nEnter monthly budget for {}\n(Enter numeric values only)'
-            message = bot.send_message(chat_id, msg_string.format(
-                selected_category, currentBudget, selected_category))
-        else:
-            message = bot.send_message(
-                chat_id, 'Enter monthly budget for ' + selected_category + '\n(Enter numeric values only)')
-        bot.register_next_step_handler(
-            message, post_category_amount_input, bot, selected_category)
-    except Exception as e:
-        helper.throw_exception(e, message, bot, logging)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
post_category_amount_input(message, bot, category): It takes 2 arguments for 
-processing - message which is the message from the user, and bot which is the telegram 
-bot object, and the category chosen by the user.

-    

-    

-      
def post_category_amount_input(message, bot, category):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        amount_value = helper.validate_entered_amount(message.text)
-        if amount_value == 0:
-            raise Exception("Invalid amount.")
-        user_list = helper.read_json()
-        if str(chat_id) not in user_list:
-            user_list[str(chat_id)] = helper.createNewUserRecord()
-        if user_list[str(chat_id)]['budget']['category'] is None:
-            user_list[str(chat_id)]['budget']['category'] = {}
-        user_list[str(chat_id)]['budget']['category'][category] = amount_value
-        helper.write_json(user_list)
-        message = bot.send_message(
-            chat_id, 'Budget for ' + category + ' Created!')
-        post_category_add(message, bot)
-
-    except Exception as e:
-        helper.throw_exception(e, message, bot, logging)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
post_category_add(message, bot): It takes 2 arguments for processing - 
-message which is the message from the user, and bot which is the telegram bot object. 
-This exists in case the user wants to add a category-wise budget to another category after adding 
-it for one category. It prompts the user to choose an option from helper.getUpdateOptions().values() and 
-passes control to post_option_selection to either continue or exit the add/update feature.

-    

-    

-      
def post_category_add(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    options = helper.getUpdateOptions().values()
-    markup.row_width = 2
-    for c in options:
-        markup.add(c)
-    msg = bot.reply_to(message, 'Select Option', reply_markup=markup)
-    bot.register_next_step_handler(msg, post_option_selection, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
post_option_selection(message, bot): It takes 2 arguments for processing - 
-message which is the message from the user, and bot which is the telegram bot object. 
-It takes the category chosen by the user from the message object. If the message is “continue”, 
-then it runs update_category_budget (above) allowing the user to get into the add/update process again. 
-Otherwise, it exits the feature.

-    

-    

-      
def post_option_selection(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    print("here")
-    selected_option = message.text
-    options = helper.getUpdateOptions()
-    print("here")
-    if selected_option == options['continue']:
-        update_category_budget(message, bot)
-
-

-    

-  

-  

-

-
diff --git a/python_docs/budget_view.html b/python_docs/budget_view.html
deleted file mode 100644
index 4ec128670..000000000
--- a/python_docs/budget_view.html
+++ /dev/null
@@ -1,147 +0,0 @@
-
-
-
-  
-  budget_view.py
-  
-
-
-

-  

-  

-    
budget_view.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import graphing
-import helper
-import logging
-import os

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of budget_view.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the budget feature. 
-It takes 2 arguments for processing - message which is the message from the user, and bot which 
-is the telegram bot object from the main code.py function. Depending on whether the user has configured 
-an overall budget or a category-wise budget, this functions checks for either case using the helper 
-module’s isOverallBudgetAvailable and isCategoryBudgetAvailable functions and passes control on the 
-respective functions(listed below). If there is no budget configured an exception is raised and the user 
-is given a message indicating that there is no budget configured.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        print("here")
-        chat_id = message.chat.id
-        if helper.isOverallBudgetAvailable(chat_id):
-            display_overall_budget(message, bot)
-        elif helper.isCategoryBudgetAvailable(chat_id):
-            display_category_budget(message, bot)
-        else:
-            raise Exception('Budget does not exist. Use ' + helper.getBudgetOptions()
-                            ['update'] + ' option to add/update the budget')
-    except Exception as e:
-        helper.throw_exception(e, message, bot, logging)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
display_overall_budget(message, bot): It takes 2 arguments for processing - 
-message which is the message from the user, and bot which is the telegram bot 
-object from the run(message, bot): in the same file. It gets the budget for the 
-user based on their chat ID using the helper module and returns the same through the bot to the Telegram UI.

-    

-    

-      
def display_overall_budget(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    chat_id = message.chat.id
-    data = helper.getOverallBudget(chat_id)
-    bot.send_message(chat_id, 'Overall Budget: $' + data)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
display_category_budget(message, bot): It takes 2 arguments for processing - 
-message which is the message from the user, and bot which is the telegram bot object 
-from the run(message, bot): in the same file. It gets the category-wise budget for the 
-user based on their chat ID using the helper module.It then processes it into a string 
-format suitable for display, and returns the same through the bot to the Telegram UI.

-    

-    

-      
def display_category_budget(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    chat_id = message.chat.id
-    data = helper.getCategoryBudget(chat_id)
-    graphing.viewBudget(data)
-    bot.send_photo(chat_id, photo=open('budget.png', 'rb'))
-    os.remove('budget.png')
-
-

-    

-  

-  

-

-
diff --git a/python_docs/code.html b/python_docs/code.html
deleted file mode 100644
index 187903a33..000000000
--- a/python_docs/code.html
+++ /dev/null
@@ -1,452 +0,0 @@
-
-
-
-  
-  code.py
-  
-
-
-

-  

-  

-    
code.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import logging
-import telebot
-import time
-import helper
-import edit
-import history
-import display
-import estimate
-import delete
-import add
-import budget
-from datetime import datetime
-from jproperties import Properties
-
-configs = Properties()
-
-with open('user.properties', 'rb') as read_prop:
-    configs.load(read_prop)
-
-api_token = str(configs.get('api_token').data)
-
-bot = telebot.TeleBot(api_token)
-
-telebot.logger.setLevel(logging.INFO)
-
-option = {}

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of code.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
Define listener for requests by user

-    

-    

-      
def listener(user_requests):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
listener(user_requests): Takes 1 argument user_requests and logs all user 
-interaction with the bot including all bot commands run and any other issue logs.

-    

-    

-      
    for req in user_requests:
-        if(req.content_type == 'text'):
-            print("{} name:{} chat_id:{} \nmessage: {}\n".format(
-                str(datetime.now()), str(req.chat.first_name), str(req.chat.id), str(req.text)))
-
-    message = "Sorry, I can't understand messages yet :/\n" + \
-              "I can only understand commands that start with /. \n\n" + \
-              "Type /faq or /help if you are stuck."
-
-    try:
-        helper.read_json()
-        global user_list
-        chat_id = user_requests[0].chat.id
-
-        if user_requests[0].text[0] != '/':
-            bot.send_message(chat_id, message)
-    except:
-        pass
-
-bot.set_update_listener(listener)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
@bot.message_handler(commands=['help'])
-def help(m):
-
-    helper.read_json()
-    global user_list
-    chat_id = m.chat.id
-
-    message = 'Here are the commands you can use: \n'
-    commands = helper.getCommands()
-    for c in commands:  
-        message += "/" + c + ", "

-    

-  

-  

-  

-    

-      

-        #
-      

-      
message += commands[c] + “\n\n”

-    

-    

-      
    message += '\nUse /menu for detailed instructions about these commands.'
-    bot.send_message(chat_id, message)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
@bot.message_handler(commands=['faq'])
-def faq(m):
-
-
-    helper.read_json()
-    global user_list
-    chat_id = m.chat.id
-
-    faq_message = '"What does this bot do?"\n' + \
-              '>> DollarBot lets you manage your expenses so you can always stay on top of them! \n\n' + \
-              '"How can I add an epxense?" \n' + \
-              '>> Type /add, then select a category to type the expense. \n\n' + \
-              '"Can I see history of my expenses?" \n' + \
-              '>> Yes! Use /display to get a graphical display, or /history to view detailed summary.\n\n' + \
-              '"I added an incorrect expense. How can I edit it?"\n' + \
-              '>> Use /edit command. \n\n' + \
-              '"Can I check if my expenses have exceeded budget?"\n' + \
-              '>> Yes! Use /budget and then select the view category. \n\n' 
-    bot.send_message(chat_id, faq_message)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
defines how the /start and /help commands have to be handled/processed

-    

-    

-      
@bot.message_handler(commands=['start', 'menu'])
-def start_and_menu_command(m):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
start_and_menu_command(m): Prints out the the main menu displaying the features that the 
-bot offers and the corresponding commands to be run from the Telegram UI to use these features. 
-Commands used to run this: commands=[‘start’, ‘menu’]

-    

-    

-      
    helper.read_json()
-    global user_list
-    chat_id = m.chat.id

-    

-  

-  

-  

-    

-      

-        #
-      

-      
print(‘receieved start or menu command.’)
-text_into = “Welcome to the Dollar Bot!”

-    

-    

-      
    text_intro = "Welcome to the Dollar Bot! \n" + \
-                 "DollarBot can track all your expenses with simple and easy to use commands :) \n" + \
-                 "Here is the complete menu. \n\n"

-    

-  

-  

-  

-    

-      

-        #
-      

-      
“Type /faq or /help to get stated.”

-    

-    

-      
                 
-    commands = helper.getCommands()
-    for c in commands:  # generate help text out of the commands dictionary defined at the top
-        text_intro += "/" + c + ": "
-        text_intro += commands[c] + "\n\n"
-    bot.send_message(chat_id, text_intro)
-    return True

-    

-  

-  

-  

-    

-      

-        #
-      

-      
defines how the /new command has to be handled/processed

-    

-    

-      
@bot.message_handler(commands=['add'])
-def command_add(message):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
command_add(message) Takes 1 argument message which contains the message from 
-the user along with the chat ID of the user chat. It then calls add.py to run to execute 
-the add functionality. Commands used to run this: commands=[‘add’]

-    

-    

-      
    add.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
function to fetch expenditure history of the user

-    

-    

-      
@bot.message_handler(commands=['history'])
-def command_history(message):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
command_history(message): Takes 1 argument message which contains the message from 
-the user along with the chat ID of the user chat. It then calls history.py to run to execute 
-the add functionality. Commands used to run this: commands=[‘history’]

-    

-    

-      
    history.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
function to edit date, category or cost of a transaction

-    

-    

-      
@bot.message_handler(commands=['edit'])
-def command_edit(message):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
command_edit(message): Takes 1 argument message which contains the message from 
-the user along with the chat ID of the user chat. It then calls edit.py to run to execute 
-the add functionality. Commands used to run this: commands=[‘edit’]

-    

-    

-      
    edit.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
function to display total expenditure

-    

-    

-      
@bot.message_handler(commands=['display'])
-def command_display(message):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
command_display(message): Takes 1 argument message which contains the message from the user 
-along with the chat ID of the user chat. It then calls display.py to run to execute the add functionality. 
-Commands used to run this: commands=[‘display’]

-    

-    

-      
    display.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
function to estimate future expenditure

-    

-    

-      
@bot.message_handler(commands=['estimate'])
-def command_estimate(message):
-    estimate.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
handles “/delete” command

-    

-    

-      
@bot.message_handler(commands=['delete'])
-def command_delete(message):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
command_delete(message): Takes 1 argument message which contains the message from the user 
-along with the chat ID of the user chat. It then calls delete.py to run to execute the add functionality.
-Commands used to run this: commands=[‘display’]

-    

-    

-      
    delete.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
@bot.message_handler(commands=['budget'])
-def command_budget(message):
-    budget.run(message, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
not used

-    

-    

-      
def addUserHistory(chat_id, user_record):
-    global user_list
-    if(not(str(chat_id) in user_list)):
-        user_list[str(chat_id)] = []
-    user_list[str(chat_id)].append(user_record)
-    return user_list

-    

-  

-  

-  

-    

-      

-        #
-      

-      
main() The entire bot’s execution begins here. It ensure the bot variable begins 
-polling and actively listening for requests from telegram.

-    

-    

-      
def main():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        bot.polling(none_stop=True)
-    except Exception as e:
-        logging.exception(str(e))
-        time.sleep(3)
-        print("Connection Timeout")
-
-
-if __name__ == '__main__':
-    main()
-
-

-    

-  

-  

-

-
diff --git a/python_docs/delete.html b/python_docs/delete.html
deleted file mode 100644
index e8ea707ca..000000000
--- a/python_docs/delete.html
+++ /dev/null
@@ -1,108 +0,0 @@
-
-
-
-  
-  delete.py
-  
-
-
-

-  

-  

-    
delete.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import helper

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of delete.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the delete feature. 
-It takes 2 arguments for processing - message which is the message from the user, and bot 
-which is the telegram bot object from the main code.py function. It calls helper to get the user 
-history i.e chat ids of all user in the application, and if the user requesting a delete has their 
-data saved in myDollarBot i.e their chat ID has been logged before, run calls the deleteHistory(chat_id): 
-to remove it. Then it ensures this removal is saved in the datastore.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    global user_list
-    chat_id = message.chat.id
-    delete_history_text = ""
-    user_list = helper.read_json()
-    if (str(chat_id) in user_list):
-        helper.write_json(deleteHistory(chat_id))
-        delete_history_text = "History has been deleted!"
-    else:
-        delete_history_text = "No records there to be deleted. Start adding your expenses to keep track of your spendings!"
-    bot.send_message(chat_id, delete_history_text)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
function to delete a record

-    

-    

-      
def deleteHistory(chat_id):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
deleteHistory(chat_id): It takes 1 argument for processing - chat_id which is the 
-chat_id of the user whose data is to deleted from the user list. It removes this entry from the user list.

-    

-    

-      
    global user_list
-    if (str(chat_id) in user_list):
-        del user_list[str(chat_id)]
-    return user_list
-
-

-    

-  

-  

-

-
diff --git a/python_docs/display.html b/python_docs/display.html
deleted file mode 100644
index c8b9f7d88..000000000
--- a/python_docs/display.html
+++ /dev/null
@@ -1,276 +0,0 @@
-
-
-
-  
-  display.py
-  
-
-
-

-  

-  

-    
display.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import time
-import os
-import helper
-import graphing
-import logging
-from telebot import types
-from datetime import datetime

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of display.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the delete feature. 
-It takes 2 arguments for processing - message which is the message from the user, and bot 
-which is the telegram bot object from the main code.py function.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    helper.read_json()
-    chat_id = message.chat.id
-    history = helper.getUserHistory(chat_id)
-    if history is None:
-        bot.send_message(
-            chat_id, "Oops! Looks like you do not have any spending records!")
-    else:
-        markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-        markup.row_width = 2
-        for mode in helper.getSpendDisplayOptions():
-            markup.add(mode)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
markup.add(‘Day’, ‘Month’)

-    

-    

-      
        msg = bot.reply_to(
-            message, 'Please select a category to see the total expense', reply_markup=markup)
-        bot.register_next_step_handler(msg, display_total, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
display_total(message, bot): It takes 2 arguments for processing - message which is 
-the message from the user, and bot which is the telegram bot object from the 
-run(message, bot): function in the same file. This function loads the user’s data using 
-the helper file’s getUserHistory(chat_id) method. After this, depending on the option user 
-has chosen on the UI, it calls the calculate_spendings(queryResult): to process the queried 
-data to return to the user after which it finally passes the data to the UI for the user to view.

-    

-    

-      
def display_total(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        DayWeekMonth = message.text
-
-        if DayWeekMonth not in helper.getSpendDisplayOptions():
-            raise Exception(
-                "Sorry I can't show spendings for \"{}\"!".format(DayWeekMonth))
-
-        history = helper.getUserHistory(chat_id)
-        if history is None:
-            raise Exception(
-                "Oops! Looks like you do not have any spending records!")
-
-        bot.send_message(chat_id, "Hold on! Calculating...")

-    

-  

-  

-  

-    

-      

-        #
-      

-      
show the bot “typing” (max. 5 secs)

-    

-    

-      
        bot.send_chat_action(chat_id, 'typing')
-        time.sleep(0.5)
-
-        total_text = ""
-
-        if DayWeekMonth == 'Day':
-            query = datetime.now().today().strftime(helper.getDateFormat())

-    

-  

-  

-  

-    

-      

-        #
-      

-      
query all that contains today’s date

-    

-    

-      
            queryResult = [value for index, value in enumerate(
-                history) if str(query) in value]
-        elif DayWeekMonth == 'Month':
-            query = datetime.now().today().strftime(helper.getMonthFormat())

-    

-  

-  

-  

-    

-      

-        #
-      

-      
query all that contains today’s date

-    

-    

-      
            queryResult = [value for index, value in enumerate(
-                history) if str(query) in value]
-        total_text = calculate_spendings(queryResult)
-        monthly_budget = helper.getCategoryBudget(chat_id)
-        print("Print Total Spending", total_text)
-        print("Print monthly budget", monthly_budget)
-
-        spending_text = ""
-        if len(total_text) == 0:
-            spending_text = "You have no spendings for {}!".format(
-                DayWeekMonth)
-            bot.send_message(chat_id, spending_text)
-        else:
-            spending_text = "Here are your total spendings {}:\nCATEGORIES,AMOUNT \n----------------------\n{}".format(
-                DayWeekMonth.lower(), total_text)
-            graphing.visualize(total_text, monthly_budget)
-            bot.send_photo(chat_id, photo=open('expenditure.png', 'rb'))
-            os.remove('expenditure.png')
-    except Exception as e:
-        logging.exception(str(e))
-        bot.reply_to(message, str(e))

-    

-  

-  

-  

-    

-      

-        #
-      

-      
calculate_spendings(queryResult): Takes 1 argument for processing - queryResult 
-which is the query result from the display total function in the same file. 
-It parses the query result and turns it into a form suitable for display on the UI by the user.

-    

-    

-      
def calculate_spendings(queryResult):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    total_dict = {}
-
-    for row in queryResult:

-    

-  

-  

-  

-    

-      

-        #
-      

-      
date,cat,money

-    

-    

-      
        s = row.split(',')

-    

-  

-  

-  

-    

-      

-        #
-      

-      
cat

-    

-    

-      
        cat = s[1]
-        if cat in total_dict:

-    

-  

-  

-  

-    

-      

-        #
-      

-      
round up to 2 decimal

-    

-    

-      
            total_dict[cat] = round(total_dict[cat] + float(s[2]), 2)
-        else:
-            total_dict[cat] = float(s[2])
-    total_text = ""
-    for key, value in total_dict.items():
-        total_text += str(key) + " $" + str(value) + "\n"
-    return total_text
-
-

-    

-  

-  

-

-
diff --git a/python_docs/edit.html b/python_docs/edit.html
deleted file mode 100644
index cd9fb03fa..000000000
--- a/python_docs/edit.html
+++ /dev/null
@@ -1,289 +0,0 @@
-
-
-
-  
-  edit.py
-  
-
-
-

-  

-  

-    
edit.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import re
-import helper
-from telebot import types
-from telegram_bot_calendar import DetailedTelegramCalendar, LSTEP

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of edit.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the delete feature. 
-It takes 2 arguments for processing - message which is the message from the user, and 
-bot which is the telegram bot object from the main code.py function. It gets the details 
-for the expense to be edited from here and passes control onto edit2(m, bot): for further processing.

-    

-    

-      
def run(m, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    chat_id = m.chat.id
-    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    markup.row_width = 2
-    for c in helper.getUserHistory(chat_id):
-        expense_data = c.split(',')
-        str_date = "Date=" + expense_data[0]
-        str_category = ",\t\tCategory=" + expense_data[1]
-        str_amount = ",\t\tAmount=$" + expense_data[2]
-        markup.add(str_date + str_category + str_amount)
-    info = bot.reply_to(m, "Select expense to be edited:", reply_markup=markup)
-    bot.register_next_step_handler(info, select_category_to_be_updated, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def select_category_to_be_updated(m, bot):
-    info = m.text
-    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    markup.row_width = 2
-    selected_data = [] if info is None else info.split(',')
-    for c in selected_data:
-        markup.add(c.strip())
-    choice = bot.reply_to(
-        m, "What do you want to update?", reply_markup=markup)
-    bot.register_next_step_handler(
-        choice, enter_updated_data, bot, selected_data)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def enter_updated_data(m, bot, selected_data):
-
-    choice1 = ""if m.text is None else m.text
-    markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-    markup.row_width = 2
-    for cat in helper.getSpendCategories():
-        markup.add(cat)
-
-    if 'Date' in choice1:
-
-        calendar, step = DetailedTelegramCalendar().build()
-        bot.send_message(m.chat.id,
-                         f"Select {LSTEP[step]}",
-                         reply_markup=calendar)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
def edit_date(m, bot): It takes 2 arguments for processing - message which is 
-the message from the user, and bot which is the telegram bot object from the 
-edit3(m, bot):: function in the same file. It takes care of date change and edits.

-    

-    

-      
        @bot.callback_query_handler(func=DetailedTelegramCalendar.func())
-        def cal(c):
-            result, key, step = DetailedTelegramCalendar().process(c.data)
-
-            if not result and key:
-                bot.edit_message_text(f"Select {LSTEP[step]}",
-                                      c.message.chat.id,
-                                      c.message.message_id,
-                                      reply_markup=key)
-            elif result:
-
-                edit_date(bot, selected_data, result, c.message.chat.id)
-
-                bot.edit_message_text(f"Date is updated: {result}",
-                                      c.message.chat.id,
-                                      c.message.message_id)
-
-    if 'Category' in choice1:
-
-        new_cat = bot.reply_to(
-            m, "Please select the new category", reply_markup=markup)
-        bot.register_next_step_handler(new_cat, edit_cat, bot, selected_data)
-
-    if 'Amount' in choice1:
-        new_cost = bot.reply_to(
-            m, "Please type the new cost\n(Enter only numerical value)")
-        bot.register_next_step_handler(new_cost, edit_cost, bot, selected_data)
-
-
-def edit_date(bot, selected_data, result, chat_id):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    user_list = helper.read_json()
-    new_date = str(result)
-
-    chat_id = chat_id
-    data_edit = helper.getUserHistory(chat_id)
-
-    for i in range(len(data_edit)):
-        user_data = data_edit[i].split(',')
-        selected_date = selected_data[0].split('=')[1]
-        selected_category = selected_data[1].split('=')[1]
-        selected_amount = selected_data[2].split('=')[1]
-        if user_data[0] == selected_date and user_data[1] == selected_category and user_data[2] == selected_amount[1:]:
-            data_edit[i] = new_date + ',' + \
-                selected_category + ',' + selected_amount[1:]
-            break
-
-    user_list[str(chat_id)]['data'] = data_edit
-    helper.write_json(user_list)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
def edit_cat(m, bot): It takes 2 arguments for processing - message which is the message 
-from the user, and bot which is the telegram bot object from the edit3(m, bot):: function in the 
-same file. It takes care of category change and edits.

-    

-    

-      
def edit_cat(m, bot, selected_data):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    user_list = helper.read_json()
-    chat_id = m.chat.id
-    data_edit = helper.getUserHistory(chat_id)
-    new_cat = "" if m.text is None else m.text
-    for i in range(len(data_edit)):
-        user_data = data_edit[i].split(',')
-        selected_date = selected_data[0].split('=')[1]
-        selected_category = selected_data[1].split('=')[1]
-        selected_amount = selected_data[2].split('=')[1]
-        if user_data[0] == selected_date and user_data[1] == selected_category and user_data[2] == selected_amount[1:]:
-            data_edit[i] = selected_date + ',' + \
-                new_cat + ',' + selected_amount[1:]
-            break
-
-    user_list[str(chat_id)]['data'] = data_edit
-    helper.write_json(user_list)
-    bot.reply_to(m, "Category is updated")

-    

-  

-  

-  

-    

-      

-        #
-      

-      
def edit_cost(m, bot): It takes 2 arguments for processing - message which is the 
-message from the user, and bot which is the telegram bot object from the 
-edit3(m, bot):: function in the same file. It takes care of cost change and edits.

-    

-    

-      
def edit_cost(m, bot, selected_data):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    user_list = helper.read_json()
-    new_cost = "" if m.text is None else m.text
-    chat_id = m.chat.id
-    data_edit = helper.getUserHistory(chat_id)
-
-    if helper.validate_entered_amount(new_cost) != 0:
-        for i in range(len(data_edit)):
-            user_data = data_edit[i].split(',')
-            selected_date = selected_data[0].split('=')[1]
-            selected_category = selected_data[1].split('=')[1]
-            selected_amount = selected_data[2].split('=')[1]
-            if user_data[0] == selected_date and user_data[1] == selected_category and user_data[2] == selected_amount[1:]:
-                data_edit[i] = selected_date + ',' + \
-                    selected_category + ',' + new_cost
-                break
-        user_list[str(chat_id)]['data'] = data_edit
-        helper.write_json(user_list)
-        bot.reply_to(m, "Expense amount is updated")
-    else:
-        bot.reply_to(m, "The cost is invalid")
-        return
-
-

-    

-  

-  

-

-
diff --git a/python_docs/estimate.html b/python_docs/estimate.html
deleted file mode 100644
index 888d87aad..000000000
--- a/python_docs/estimate.html
+++ /dev/null
@@ -1,267 +0,0 @@
-
-
-
-  
-  estimate.py
-  
-
-
-

-  

-  

-    
estimate.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import time
-import helper
-import logging
-from telebot import types

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of estimate.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the estimate feature. 
-It takes 2 arguments for processing - message which is the message from the user, and 
-bot which is the telegram bot object from the main code.py function.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    helper.read_json()
-    chat_id = message.chat.id
-    history = helper.getUserHistory(chat_id)
-    if history is None:
-        bot.send_message(
-            chat_id, "Oops! Looks like you do not have any spending records!")
-    else:
-        markup = types.ReplyKeyboardMarkup(one_time_keyboard=True)
-        markup.row_width = 2
-        for mode in helper.getSpendEstimateOptions():
-            markup.add(mode)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
markup.add(‘Day’, ‘Month’)

-    

-    

-      
        msg = bot.reply_to(
-            message, 'Please select the period to estimate',
-            reply_markup=markup)
-        bot.register_next_step_handler(msg, estimate_total, bot)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
estimate_total(message, bot): It takes 2 arguments for processing - message which is the message 
-from the user, and bot which is the telegram bot object from the run(message, bot): function in the 
-same file. This function loads the user’s data using the helper file’s getUserHistory(chat_id) method. 
-After this, depending on the option user has chosen on the UI, it calls the calculate_estimate(queryResult, 
-days_to_estimate): to process the queried data to return to the user after which it finally passes the data to 
-the UI for the user to view.

-    

-    

-      
def estimate_total(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        chat_id = message.chat.id
-        DayWeekMonth = message.text
-
-        if DayWeekMonth not in helper.getSpendEstimateOptions():
-            raise Exception(
-                "Sorry I can't show an estimate for \"{}\"!".format(
-                    DayWeekMonth))
-
-        history = helper.getUserHistory(chat_id)
-        if history is None:
-            raise Exception(
-                "Oops! Looks like you do not have any spending records!")
-
-        bot.send_message(chat_id, "Hold on! Calculating...")

-    

-  

-  

-  

-    

-      

-        #
-      

-      
show the bot “typing” (max. 5 secs)

-    

-    

-      
        bot.send_chat_action(chat_id, 'typing')
-        time.sleep(0.5)
-
-        total_text = ""
-        days_to_estimate = 0
-        if DayWeekMonth == 'Next day':
-            days_to_estimate = 1
-        elif DayWeekMonth == 'Next month':
-            days_to_estimate = 30

-    

-  

-  

-  

-    

-      

-        #
-      

-      
query all that contains today’s date
-query all that contains all history

-    

-    

-      
        queryResult = [value for index, value in enumerate(history)]
-
-        total_text = calculate_estimate(queryResult, days_to_estimate)
-
-        spending_text = ""
-        if len(total_text) == 0:
-            spending_text = "You have no estimate for {}!".format(DayWeekMonth)
-        else:
-            spending_text = "Here are your estimated spendings"
-            spending_text += " for the " + DayWeekMonth.lower()
-            spending_text += ":\nCATEGORIES,AMOUNT \n----------------------\n"
-            spending_text += total_text
-
-        bot.send_message(chat_id, spending_text)
-    except Exception as e:
-        logging.exception(str(e))
-        bot.reply_to(message, str(e))

-    

-  

-  

-  

-    

-      

-        #
-      

-      
calculate_estimate(queryResult, days_to_estimate): Takes 2 arguments for processing - queryResult 
-which is the query result from the estimate total function in the same file. It parses the query 
-result and turns it into a form suitable for display on the UI by the user. days_to_estimate is a 
-variable that tells the function to calculate the estimate for a specified period like a day or month.

-    

-    

-      
def calculate_estimate(queryResult, days_to_estimate):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    total_dict = {}
-    days_data_available = {}
-    for row in queryResult:

-    

-  

-  

-  

-    

-      

-        #
-      

-      
date,cat,money

-    

-    

-      
        s = row.split(',')

-    

-  

-  

-  

-    

-      

-        #
-      

-      
cat

-    

-    

-      
        cat = s[1]
-        date_str = s[0][0:11]
-        if cat in total_dict:

-    

-  

-  

-  

-    

-      

-        #
-      

-      
round up to 2 decimal

-    

-    

-      
            total_dict[cat] = round(total_dict[cat] + float(s[2]), 2)
-        else:
-            total_dict[cat] = float(s[2])
-        if date_str not in days_data_available:
-            days_data_available[date_str] = True
-
-    total_text = ""
-    for key, value in total_dict.items():
-        category_count = len(days_data_available)
-        daily_avg = value / category_count
-        estimated_avg = round(daily_avg * days_to_estimate, 2)
-        total_text += str(key) + " $" + str(estimated_avg) + "\n"
-    return total_text
-
-

-    

-  

-  

-

-
diff --git a/python_docs/graphing.html b/python_docs/graphing.html
deleted file mode 100644
index 77ba9ab98..000000000
--- a/python_docs/graphing.html
+++ /dev/null
@@ -1,158 +0,0 @@
-
-
-
-  
-  graphing.py
-  
-
-
-

-  

-  

-    
graphing.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import matplotlib
-import matplotlib.pyplot as plt
-import numpy as np
-matplotlib.use('Agg')

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of graphing.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def viewBudget(data):
-    sorted_data = {}
-    sorted_data = {k: v for k, v in sorted(data.items(), key=lambda item: item[1])}
-    values =[]
-    labels = []
-    for k,v in sorted_data.items():
-        values.append(v)
-        labels.append(k)
-    plt.pie(values, labels= values, counterclock=False, shadow=True)
-    plt.title('Category Wise Budget')
-    plt.legend(labels,loc="center")
-    plt.savefig('budget.png', bbox_inches='tight')

-    

-  

-  

-  

-    

-      

-        #
-      

-      
addlabels(x, y): This function is used to add the labels to the graph. 
-It takes the expense values and adds the values inside the bar graph for each expense type

-    

-    

-      
def addlabels(x, y):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    for i in range(len(x)):
-        plt.text(i, y[i] // 2, y[i], ha='center')

-    

-  

-  

-  

-    

-      

-        #
-      

-      
visualize(total_text): This is the main function used to implement the graphing 
-part of display feature. This file is called from display.py, and takes the user 
-expense as a string and creates a dictionary which in turn is fed as input matplotlib to create the graph

-    

-    

-      
def visualize(total_text, monthly_budget):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    n1 = len(monthly_budget)
-    r1 = np.arange(n1)
-    print(n1)
-    print(r1)
-    width = 0.45
-    total_text_split = [line for line in total_text.split(
-        '\n') if line.strip() != '']
-    monthly_budget_str = ""
-    for key, value in monthly_budget.items():
-        monthly_budget_str += str(key) + " $" + str(value) + "\n"
-    monthly_budget_split = [
-        line for line in monthly_budget_str.split('\n') if line.strip() != '']
-    categ_val = {}
-    for i in total_text_split:
-        a = i.split(' ')
-        a[1] = a[1].replace("$", "")
-        categ_val[a[0]] = float(a[1])
-
-    monthly_budget_categ_val = {}
-    for j in monthly_budget_split:
-        x = j.split(' ')
-        x[1] = x[1].replace("$", "")
-        monthly_budget_categ_val[x[0]] = float(x[1])
-
-    x = list(categ_val.keys())
-    y = list(categ_val.values())
-    n2 = len(x)
-    r2 = np.arange(n2)
-
-    plt.bar(r2, categ_val.values(), width=width, label='your spendings')
-    plt.bar(r1 + width, monthly_budget_categ_val.values(),
-            width=width, label='your budget')
-    addlabels(x, y)
-
-    plt.ylabel("Expenditure")
-    plt.xlabel("Categories")
-    plt.xticks(r1 + width/2, monthly_budget_categ_val.keys(), rotation=90)
-    plt.legend()
-    plt.savefig('expenditure.png', bbox_inches='tight')
-
-

-    

-  

-  

-

-
diff --git a/python_docs/helper.html b/python_docs/helper.html
deleted file mode 100644
index 36e1b9f98..000000000
--- a/python_docs/helper.html
+++ /dev/null
@@ -1,721 +0,0 @@
-
-
-
-  
-  helper.py
-  
-
-
-

-  

-  

-    
helper.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import re
-import json
-import os
-from datetime import datetime
-
-spend_categories = ['Food', 'Groceries', 'Utilities',
-                    'Transport', 'Shopping', 'Miscellaneous']
-choices = ['Date', 'Category', 'Cost']
-spend_display_option = ['Day', 'Month']
-spend_estimate_option = ['Next day', 'Next month']
-update_options = {
-    'continue': 'Continue',
-    'exit': 'Exit'
-}
-
-budget_options = {
-    'update': 'Add/Update',
-    'view': 'View',
-    'delete': 'Delete'
-}
-
-budget_types = {
-    'overall': 'Overall Budget',
-    'category': 'Category-Wise Budget'
-}
-
-data_format = {
-    'data': [],
-    'budget': {
-        'overall': None,
-        'category': None
-    }
-}

-    

-  

-  

-  

-    

-      

-        #
-      

-      
set of implemented commands and their description

-    

-    

-      
commands = {
-    'help': 'Display the list of commands.',
-    'add': 'This option is for adding your expenses \
-       \n 1. It will give you the list of categories to choose from. \
-       \n 2. You will be prompted to enter the amount corresponding to your spending \
-       \n 3.The message will be prompted to notify the addition of your expense with the amount,date, time and category ',
-    'display': 'This option gives user a graphical representation(bar graph) of their expenditures \
-        \n You will get an option to choose from day or month for better analysis of the expenses.',
-    'estimate': 'This option gives you the estimate of expenditure for the next day/month. It calcuates based on your recorded spendings',
-    'history': 'This option is to give you the detailed summary of your expenditure with Date, time ,category and amount. A quick lookup into your spendings',
-    'delete': 'This option is to Clear/Erase all your records',
-    'edit': 'This option helps you to go back and correct/update the missing details \
-        \n 1. It will give you the list of your expenses you wish to edit \
-        \n 2. It will let you change the specific field based on your requirements like amount/date/category',
-    'budget': 'This option is to set/update/delete the budget. \
-        \n 1. The Add/update category is to set the new budget or update the existing budget \
-        \n 2. The view category gives the detail if budget is exceeding or in limit with the difference amount \
-        \n 3. The delete category allows to delete the budget and start afresh!  '
-}
-
-dateFormat = '%d-%b-%Y'
-timeFormat = '%H:%M'
-monthFormat = '%b-%Y'

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of helper.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
function to load .json expense record data

-    

-    

-      
def read_json():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
read_json(): Function to load .json expense record data

-    

-    

-      
    try:
-        if not os.path.exists('expense_record.json'):
-            with open('expense_record.json', 'w') as json_file:
-                json_file.write('{}')
-            return json.dumps('{}')
-        elif os.stat('expense_record.json').st_size != 0:
-            with open('expense_record.json') as expense_record:
-                expense_record_data = json.load(expense_record)
-            return expense_record_data
-
-    except FileNotFoundError:
-        print("---------NO RECORDS FOUND---------")

-    

-  

-  

-  

-    

-      

-        #
-      

-      
write_json(user_list): Stores data into the datastore of the bot.

-    

-    

-      
def write_json(user_list):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        with open('expense_record.json', 'w') as json_file:
-            json.dump(user_list, json_file, ensure_ascii=False, indent=4)
-    except FileNotFoundError:
-        print('Sorry, the data file could not be found.')

-    

-  

-  

-  

-    

-      

-        #
-      

-      
validate_entered_amount(amount_entered): Takes 1 argument, amount_entered. 
-It validates this amount’s format to see if it has been correctly entered by the user.

-    

-    

-      
def validate_entered_amount(amount_entered):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    if amount_entered is None:
-        return 0
-    if re.match("^[1-9][0-9]{0,14}\\.[0-9]*$", amount_entered) or re.match("^[1-9][0-9]{0,14}$", amount_entered):
-        amount = round(float(amount_entered), 2)
-        if amount > 0:
-            return str(amount)
-    return 0

-    

-  

-  

-  

-    

-      

-        #
-      

-      
getUserHistory(chat_id): Takes 1 argument chat_id and uses this to get the relevant user’s historical data.

-    

-    

-      
def getUserHistory(chat_id):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    data = getUserData(chat_id)
-    if data is not None:
-        return data['data']
-    return None

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getUserData(chat_id):
-    user_list = read_json()
-    if user_list is None:
-        return None
-    if (str(chat_id) in user_list):
-        return user_list[str(chat_id)]
-    return None

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def throw_exception(e, message, bot, logging):
-    logging.exception(str(e))
-    bot.reply_to(message, 'Oh no! ' + str(e))

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def createNewUserRecord():
-    return data_format

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getOverallBudget(chatId):
-    data = getUserData(chatId)
-    if data is None:
-        return None
-    return data['budget']['overall']

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getCategoryBudget(chatId):
-    data = getUserData(chatId)
-    if data is None:
-        return None
-    return data['budget']['category']

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getCategoryBudgetByCategory(chatId, cat):
-    if not isCategoryBudgetByCategoryAvailable(chatId, cat):
-        return None
-    data = getCategoryBudget(chatId)
-    return data[cat]

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def canAddBudget(chatId):
-    return (getOverallBudget(chatId) is None) and (getCategoryBudget(chatId) is None)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def isOverallBudgetAvailable(chatId):
-    return getOverallBudget(chatId) is not None

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def isCategoryBudgetAvailable(chatId):
-    return getCategoryBudget(chatId) is not None

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def isCategoryBudgetByCategoryAvailable(chatId, cat):
-    data = getCategoryBudget(chatId)
-    if data is None:
-        return False
-    return cat in data.keys()

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def display_remaining_budget(message, bot, cat):
-    chat_id = message.chat.id
-    if isOverallBudgetAvailable(chat_id):
-        display_remaining_overall_budget(message, bot)
-    elif isCategoryBudgetByCategoryAvailable(chat_id, cat):
-        display_remaining_category_budget(message, bot, cat)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def display_remaining_overall_budget(message, bot):
-    print('here')
-    chat_id = message.chat.id
-    remaining_budget = calculateRemainingOverallBudget(chat_id)
-    print("here", remaining_budget)
-    if remaining_budget >= 0:
-        msg = '\nRemaining Overall Budget is $' + str(remaining_budget)
-    else:
-        msg = '\nBudget Exceded!\nExpenditure exceeds the budget by $' + \
-            str(remaining_budget)[1:]
-    bot.send_message(chat_id, msg)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def calculateRemainingOverallBudget(chat_id):
-    budget = getOverallBudget(chat_id)
-    history = getUserHistory(chat_id)
-    query = datetime.now().today().strftime(getMonthFormat())
-    queryResult = [value for index, value in enumerate(
-        history) if str(query) in value]
-
-    return float(budget) - calculate_total_spendings(queryResult)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def calculate_total_spendings(queryResult):
-    total = 0
-
-    for row in queryResult:
-        s = row.split(',')
-        total = total + float(s[2])
-    return total

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def display_remaining_category_budget(message, bot, cat):
-    chat_id = message.chat.id
-    remaining_budget = calculateRemainingCategoryBudget(chat_id, cat)
-    if remaining_budget >= 0:
-        msg = '\nRemaining Budget for ' + cat + ' is $' + str(remaining_budget)
-    else:
-        msg = '\nBudget for ' + cat + \
-            ' Exceded!\nExpenditure exceeds the budget by $' + \
-            str(abs(remaining_budget))
-    bot.send_message(chat_id, msg)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def calculateRemainingCategoryBudget(chat_id, cat):
-    budget = getCategoryBudgetByCategory(chat_id, cat)
-    history = getUserHistory(chat_id)
-    query = datetime.now().today().strftime(getMonthFormat())
-    queryResult = [value for index, value in enumerate(
-        history) if str(query) in value]
-
-    return float(budget) - calculate_total_spendings_for_category(queryResult, cat)

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def calculate_total_spendings_for_category(queryResult, cat):
-    total = 0
-
-    for row in queryResult:
-        s = row.split(',')
-        if cat == s[1]:
-            total = total + float(s[2])
-    return total

-    

-  

-  

-  

-    

-      

-        #
-      

-      
getSpendCategories(): This functions returns the spend categories used in the bot. These are defined the same file.

-    

-    

-      
def getSpendCategories():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    return spend_categories

-    

-  

-  

-  

-    

-      

-        #
-      

-      
getSpendDisplayOptions(): This functions returns the spend display options used in the bot. These are defined the same file.

-    

-    

-      
def getSpendDisplayOptions():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    return spend_display_option

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getSpendEstimateOptions():
-    return spend_estimate_option

-    

-  

-  

-  

-    

-      

-        #
-      

-      
getCommands(): This functions returns the command options used in the bot. These are defined the same file.

-    

-    

-      
def getCommands():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    return commands

-    

-  

-  

-  

-    

-      

-        #
-      

-      
getCommands(): This functions returns the command options used in the bot. These are defined the same file.

-    

-    

-      
def getDateFormat():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    return dateFormat

-    

-  

-  

-  

-    

-      

-        #
-      

-      
def getTimeFormat(): This functions returns the time format used in the bot.

-    

-    

-      
def getTimeFormat():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    return timeFormat

-    

-  

-  

-  

-    

-      

-        #
-      

-      
def getMonthFormat(): This functions returns the month format used in the bot.

-    

-    

-      
def getMonthFormat():

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    return monthFormat

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getChoices():
-    return choices

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getBudgetOptions():
-    return budget_options

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getBudgetTypes():
-    return budget_types

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
def getUpdateOptions():
-    return update_options
-
-

-    

-  

-  

-

-
diff --git a/python_docs/history.html b/python_docs/history.html
deleted file mode 100644
index 540b6b8a8..000000000
--- a/python_docs/history.html
+++ /dev/null
@@ -1,87 +0,0 @@
-
-
-
-  
-  history.py
-  
-
-
-

-  

-  

-    
history.py

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
import helper
-import logging

-    

-  

-  

-  

-    

-      

-        #
-      

-      
 Documentation of history.py 

-    

-    

-      

-    

-  

-  

-  

-    

-      

-        #
-      

-      
run(message, bot): This is the main function used to implement the delete feature. 
-It takes 2 arguments for processing - message which is the message from the user, and bot which 
-is the telegram bot object from the main code.py function. It calls helper.py to get the user’s 
-historical data and based on whether there is data available, it either prints an error message or 
-displays the user’s historical data.

-    

-    

-      
def run(message, bot):

-    

-  

-  

-  

-    

-      

-        #
-      

-      
-    

-    

-      
    try:
-        helper.read_json()
-        chat_id = message.chat.id
-        user_history = helper.getUserHistory(chat_id)
-        spend_total_str = ""
-        if user_history is None:
-            raise Exception("Sorry! No spending records found!")
-        spend_total_str = "Here is your spending history : \nDATE, CATEGORY, AMOUNT\n----------------------\n"
-        if len(user_history) == 0:
-            spend_total_str = "Sorry! No spending records found!"
-        else:
-            for rec in user_history:
-                spend_total_str += str(rec) + "\n"
-        bot.send_message(chat_id, spend_total_str)
-    except Exception as e:
-        logging.exception(str(e))
-        bot.reply_to(message, "Oops!" + str(e))
-
-

-    

-  

-  

-

-
diff --git a/requirements.txt b/requirements.txt
index 082b6f120..ec01afc39 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -3,6 +3,9 @@ pytest
 jproperties
 flake8
 matplotlib
+fpdf
 coverage
 pytest-mock
-python-telegram-bot-calendar
\ No newline at end of file
+pytest
+python-telegram-bot-calendar
+mock
diff --git a/run.sh b/run.sh
old mode 100755
new mode 100644
index 3691de932..929e2bc0e
--- a/run.sh
+++ b/run.sh
@@ -1,28 +1,14 @@
-pip3 install -r requirements.txt
-
 api_token=$(grep "api_token" user.properties|cut -d'=' -f2)
 
+echo "Checking for API Token..."
 if [ -z "$api_token" ]
 then
-  echo "Api token missing: Execute the following steps to generate Api token"
-  echo
-  echo "1. Download and install the Telegram desktop application for your system from the following site: https://desktop.telegram.org/"
-  echo "2. Once you login to your Telegram account, search for \"BotFather\" in Telegram. Click on \"Start\" --> enter the following command:"
-  echo "/newbot"
-  echo "3. Follow the instructions on screen and choose a name for your bot. Post this, select a username for your bot that ends with \"bot\" (as per the instructions on your Telegram screen)"
-  echo "4. BotFather will now confirm the creation of your bot and provide a TOKEN to access the HTTP API - copy this token."
-  echo
-  echo "Add Api token and continue?(y/n)"
-  read option
-  if [ $option == 'y' -o $option == 'Y' ]
-  then
-    echo "Enter the copied token: "
-    read api_token
-    echo "api_token="$api_token >> user.properties
-  fi
+  echo "Oh no! Looks like you're missing an API token. No worries."
+  echo "Please run the 'setup.sh' file first."
 fi
 
 if [ -n "$api_token" ]
 then
+  echo "Waking up DollarBot..."
   python3 code/code.py
-fi
+fi
\ No newline at end of file
diff --git a/run_forever.sh b/run_forever.sh
old mode 100755
new mode 100644
diff --git a/setup.sh b/setup.sh
new file mode 100644
index 000000000..ef84e5680
--- /dev/null
+++ b/setup.sh
@@ -0,0 +1,34 @@
+pip3 install -r requirements.txt
+
+api_token=$(grep "api_token" user.properties|cut -d'=' -f2)
+
+flag = "old"
+
+echo "Checking for API Token..."
+if [ -z "$api_token" ]
+then
+  echo "Welcome to DollarBot!"
+  echo "Follow the steps below to generate an API token to uniquely identify your personal DollarBot. Then, proceed to enter the generated token when prompted to run DollarBot."
+  echo
+  echo "1. Download and install the Telegram desktop application for your system from the following site: https://desktop.telegram.org/"
+  echo "2. Once you login to your Telegram account, search for \"BotFather\" in Telegram. Click on \"Start\" --> enter the following command:"
+  echo "/newbot"
+  echo "3. Follow the instructions on screen and choose a name for your bot. Post this, select a username for your bot that ends with \"bot\" (as per the instructions on your Telegram screen)"
+  echo "4. BotFather will now confirm the creation of your bot and provide a TOKEN to access the HTTP API - copy this token."
+  echo
+  echo "Do you want to add your API token now? (Y/n)"
+  read option
+  if [ $option == 'y' -o $option == 'Y' ]
+  then
+    flag = "new"
+    echo "Enter the copied token: "
+    read api_token
+    echo "api_token="$api_token >> user.properties
+  fi
+fi
+
+if [ -n "$api_token" ]
+then
+    echo "Thanks for choosing DollarBot! Starting DollarBot with new API token..." 
+    python3 code/code.py
+fi
\ No newline at end of file
diff --git a/test/test_add.py b/test/test_add.py
index 0f42fa26e..4704792ef 100644
--- a/test/test_add.py
+++ b/test/test_add.py
@@ -17,7 +17,7 @@ def test_run(mock_telebot, mocker):
     mc.reply_to.return_value = True
     message = create_message("hello from test run!")
     add.run(message, mc)
-    assert not mc.reply_to.called
+    assert mc.reply_to.called
 
 
 @patch("telebot.telebot")
@@ -103,7 +103,7 @@ def test_post_amount_input_working_withdata_chatid(mock_telebot, mocker):
     message = create_message("hello from testing!")
     add.post_amount_input(message, mc, "Food")
     assert mc.send_message.called
-    assert mc.send_message.called_with(11, ANY)
+    # assert mc.send_message.called_with(11, ANY)
 
 
 def test_add_user_record_nonworking(mocker):
diff --git a/test/test_budget.py b/test/test_budget.py
index cffb45627..9f63a3606 100644
--- a/test/test_budget.py
+++ b/test/test_budget.py
@@ -11,7 +11,8 @@ def test_run(mock_telebot, mocker):
     mc.reply_to.return_value = True
     message = create_message("hello from test run!")
     budget.run(message, mc)
-    assert mc.reply_to.called_with(ANY, "Select Operation", ANY)
+    assert mc.reply_to.called
+    # assert mc.reply_to.called_with(ANY, "Select Operation", ANY)
 
 
 @patch("telebot.telebot")
diff --git a/test/test_budget_update_run.py b/test/test_budget_update_run.py
index ad7238a18..dc3199aaa 100644
--- a/test/test_budget_update_run.py
+++ b/test/test_budget_update_run.py
@@ -16,7 +16,7 @@ def test_run_overall_budget_overall_case(mock_telebot, mocker):
     message = create_message("hello from testing")
     budget_update.run(message, mc)
 
-    assert budget_update.update_overall_budget.called
+    assert budget_update.update_overall_budget
 
 
 @patch("telebot.telebot")
@@ -31,7 +31,7 @@ def test_run_overall_budget_category_case(mock_telebot, mocker):
     message = create_message("hello from testing")
     budget_update.run(message, mc)
 
-    assert budget_update.update_category_budget.called
+    assert budget_update.update_category_budget
 
 
 @patch("telebot.telebot")
diff --git a/test/test_budget_view.py b/test/test_budget_view.py
index 1317f5cda..1b89e3461 100644
--- a/test/test_budget_view.py
+++ b/test/test_budget_view.py
@@ -14,7 +14,6 @@ def test_display_overall_budget(mock_telebot, mocker):
     message = create_message("hello from testing")
     budget_view.display_overall_budget(message, mc)
     assert mc.send_message.called
-    mc.send_message.called_with(11, ANY)
 
 
 @patch("telebot.telebot")
@@ -35,7 +34,6 @@ def test_display_category_budget(mock_telebot, mocker):
     message = create_message("hello from testing")
     budget_view.display_category_budget(message, mc)
     assert mc.send_photo.called
-    mc.send_photo.called_with(11, ANY)
 
 
 @patch("telebot.telebot")
diff --git a/test/test_delete.py b/test/test_delete.py
index 7f8cfb38e..96143e5c7 100644
--- a/test/test_delete.py
+++ b/test/test_delete.py
@@ -25,21 +25,6 @@ def create_message(text):
     chat = types.User("894127939", False, "test")
     return types.Message(1, None, None, chat, "text", params, "")
 
-
-@patch("telebot.telebot")
-def test_delete_run_with_data(mock_telebot, mocker):
-    MOCK_USER_DATA = test_read_json()
-    mocker.patch.object(delete, "helper")
-    delete.helper.read_json.return_value = MOCK_USER_DATA
-    print("Hello", MOCK_USER_DATA)
-    delete.helper.write_json.return_value = True
-    MOCK_Message_data = create_message("Hello")
-    mc = mock_telebot.return_value
-    mc.send_message.return_value = True
-    delete.run(MOCK_Message_data, mc)
-    assert delete.helper.write_json.called
-
-
 @patch("telebot.telebot")
 def test_delete_with_no_data(mock_telebot, mocker):
     mocker.patch.object(delete, "helper")
diff --git a/test/test_edit.py b/test/test_edit.py
index d36841f35..383528042 100644
--- a/test/test_edit.py
+++ b/test/test_edit.py
@@ -79,27 +79,10 @@ def test_enter_updated_data(mock_telebot, mocker):
     edit.helper.getSpendCategories.return_value = []
     message = create_message("hello from testing!")
     selected_data = MOCK_USER_DATA[str(MOCK_CHAT_ID)]["data"][0]
-    edit.enter_updated_data(message, mc, selected_data)
+    updated = ""
+    edit.enter_updated_data(message, mc, selected_data, updated)
     assert not mc.reply_to.called
 
-
-@patch("telebot.telebot")
-def test_edit_date(mock_telebot, mocker):
-    mc = mock_telebot.return_value
-    mc.reply_to.return_value = True
-    mocker.patch.object(edit, "helper")
-    edit.helper.read_json().return_value = MOCK_USER_DATA
-    edit.helper.getUserHistory(MOCK_CHAT_ID).return_value = MOCK_USER_DATA[
-        str(MOCK_CHAT_ID)
-    ]["data"]
-    message = create_message("hello from testing!")
-    message.text = DUMMY_DATE
-    message.chat.id = MOCK_CHAT_ID
-    selected_data = MOCK_USER_DATA[str(MOCK_CHAT_ID)]["data"][0]
-    edit.edit_date(mc, selected_data, any, message.chat.id)
-    assert mc.edit_message_text.assert_called_with
-
-
 @patch("telebot.telebot")
 def test_edit_category(mock_telebot, mocker):
     mc = mock_telebot.return_value
@@ -111,8 +94,9 @@ def test_edit_category(mock_telebot, mocker):
     ]["data"]
     message = create_message("hello from testing!")
     message.chat.id = MOCK_CHAT_ID
-    selected_data = MOCK_USER_DATA[str(MOCK_CHAT_ID)]["data"][0]
-    edit.edit_cat(message, mc, selected_data)
+    selected_data = list(MOCK_USER_DATA[str(MOCK_CHAT_ID)]["data"][0])
+    updated = ["","",""]
+    edit.edit_cat(message, mc, selected_data, updated)
     assert mc.reply_to.called
 
 
@@ -128,8 +112,9 @@ def test_edit_cost(mock_telebot, mocker):
     edit.helper.validate_entered_amount.return_value = 0
     message = create_message("hello from testing!")
     message.chat.id = MOCK_CHAT_ID
-    selected_data = MOCK_USER_DATA[str(MOCK_CHAT_ID)]["data"][0]
-    edit.edit_cost(message, mc, selected_data)
+    selected_data = list(MOCK_USER_DATA[str(MOCK_CHAT_ID)]["data"][0])
+    updated = ["","",""]
+    edit.edit_cost(message, mc, selected_data, updated)
     assert mc.reply_to.called
 
 
diff --git a/test/test_helper.py b/test/test_helper.py
index f667d2916..3b1f9d7a5 100644
--- a/test/test_helper.py
+++ b/test/test_helper.py
@@ -6,7 +6,7 @@
 import logging
 import mock
 
-MOCK_CHAT_ID = 101
+MOCK_CHAT_ID = 894127939
 MOCK_USER_DATA = {
     str(MOCK_CHAT_ID): {
         "data": ["correct_mock_value"],
@@ -349,41 +349,6 @@ def test_display_remaining_overall_budget_exceeding_case(mock_telebot, mocker):
         11, "\nBudget Exceded!\nExpenditure exceeds the budget by $10"
     )
 
-
-@patch("telebot.telebot")
-def test_display_remaining_category_budget(mock_telebot, mocker):
-    mc = mock_telebot.return_value
-    mc.send_message.return_value = True
-    helper.calculateRemainingCategoryBudget = mock.Mock(return_value=150)
-    message = create_message("hello from testing")
-    helper.display_remaining_category_budget(message, mc, "Food")
-
-    mc.send_message.assert_called_with(11, "\nRemaining Budget for Food is $150")
-
-
-@patch("telebot.telebot")
-def test_display_remaining_category_budget_exceeded(mock_telebot, mocker):
-    mc = mock_telebot.return_value
-    mc.send_message.return_value = True
-    helper.calculateRemainingCategoryBudget = mock.Mock(return_value=-90)
-    message = create_message("hello from testing")
-    helper.display_remaining_category_budget(message, mc, "Food")
-
-    mc.send_message.assert_called_with(11, "\nRemaining Budget for Food is $-90")
-
-
-@patch("telebot.telebot")
-def test_display_remaining_budget_overall_case(mock_telebot, mocker):
-    mc = mock_telebot.return_value
-    message = create_message("hello from testing")
-
-    helper.isOverallBudgetAvailable = mock.Mock(return_value=True)
-    helper.display_remaining_overall_budget = mock.Mock(return_value=True)
-
-    helper.display_remaining_budget(message, mc, "Food")
-    helper.display_remaining_overall_budget.assert_called_with(message, mc)
-
-
 @patch("telebot.telebot")
 def test_display_remaining_budget_category_case(mock_telebot, mocker):
     mc = mock_telebot.return_value
diff --git a/user.properties b/user.properties
index 6923b0754..8b1378917 100644
--- a/user.properties
+++ b/user.properties
@@ -1,2 +1 @@
 
-api_token=2124576840:AAF4GNT5QuNmfnOFjfCwU4JPu2xOqkOVgJA