Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
175 commits
Select commit Hold shift + click to select a range
fb51661
Removed empty doco files not compatible with windows
shashank-madan Oct 8, 2023
23d03e1
Update and rename custom.md to bug-template.md
aditikilledar Oct 8, 2023
1a9fc03
Update and rename issue-task-template.md to docu-template.md
aditikilledar Oct 8, 2023
b5239a2
Update docu-template.md
aditikilledar Oct 8, 2023
bfc15d1
Update bug-template.md
aditikilledar Oct 8, 2023
38f938d
Update docu-template.md
aditikilledar Oct 8, 2023
7410c5a
Update docu-template.md
aditikilledar Oct 8, 2023
7da45ce
Create enhancement.md
aditikilledar Oct 8, 2023
4522626
Update docu-template.md
aditikilledar Oct 8, 2023
bac7fb0
Create other-issues.md
aditikilledar Oct 8, 2023
626cbeb
budget command bugfixes
shashank-madan Oct 8, 2023
1765990
Fixed bug #13 in run.sh and split into setup.sh (#14 solved)
aditikilledar Oct 8, 2023
a652019
Merge branch 'main' of https://github.com/aditikilledar/dollar_bot_SE23
shashank-madan Oct 8, 2023
5325efc
add new category while setting category-wise budget
shashank-madan Oct 8, 2023
9213c1b
Merge branch 'feature-update-budget-command'
shashank-madan Oct 8, 2023
7d07ce4
handle uncategorized budget
shashank-madan Oct 9, 2023
03d8138
Merge branch 'feature-update-budget-command'
shashank-madan Oct 9, 2023
61cd347
Merge pull request #15 from aditikilledar/feature-update-budget-command
aditikilledar Oct 10, 2023
90e3c84
Merge pull request #16 from aditikilledar/bugfix-setup-installation-r…
aditikilledar Oct 10, 2023
4e0252f
Merge branch 'main' of https://github.com/aditikilledar/dollar_bot_SE23
shashank-madan Oct 10, 2023
136a846
update budget bugfix
shashank-madan Oct 10, 2023
7af0aa2
update add command and bugfixes
shashank-madan Oct 10, 2023
7654927
Merge pull request #17 from aditikilledar/feature-update-budget-command
aditikilledar Oct 10, 2023
a754e41
Merge pull request #18 from aditikilledar/feature-update-add-command
shashank-madan Oct 11, 2023
068801f
Reworked add expense workflow
shashank-madan Oct 11, 2023
9ca00ca
Update README.md
aditikilledar Oct 12, 2023
8bb884f
Update README.md
aditikilledar Oct 13, 2023
4caf8ee
Update README.md
aditikilledar Oct 13, 2023
415b1f4
pushing initial analytics feat
srina1h Oct 13, 2023
f353889
added fix for graph
srina1h Oct 13, 2023
e6ebf55
implemented suggested changes in add expenses workflow
shashank-madan Oct 13, 2023
5f77295
Update README.md with run_forever instructions
aditikilledar Oct 13, 2023
1ea144e
Create Developer_ReadMe.md
aditikilledar Oct 13, 2023
563f0f5
Update README.md as only User ReadMe
aditikilledar Oct 14, 2023
9b07105
Update Developer_ReadMe.md as dev readme
aditikilledar Oct 14, 2023
3927cfd
Update README.md
aditikilledar Oct 14, 2023
3af44d8
Update README.md for Table of Contents
aditikilledar Oct 14, 2023
88182c2
Merge pull request #25 from aditikilledar/feature-update-add-command
aditikilledar Oct 14, 2023
e2c3202
added recurring expenses functionality
shashank-madan Oct 14, 2023
d93dcf7
Merge branch 'feature-update-add-command'
shashank-madan Oct 14, 2023
c3b1233
Merge pull request #31 from aditikilledar/feature-update-add-command
shashank-madan Oct 14, 2023
36339ae
Merge branch 'main' into analytics_feature
srina1h Oct 14, 2023
60283c0
Merge branch 'main' of https://github.com/aditikilledar/dollar_bot_SE23
shashank-madan Oct 14, 2023
f5536c9
Completed analytics functionality
srina1h Oct 14, 2023
7bc6f42
edit command issue resolved
shashank-madan Oct 15, 2023
70079ed
edge case bugfix
shashank-madan Oct 15, 2023
f900ff2
Update CONTRIBUTING.md
aditikilledar Oct 15, 2023
fd35e63
Incorporated review recommendations
aditikilledar Oct 15, 2023
5ac6a08
recurring expenses bugfix
shashank-madan Oct 15, 2023
ae76328
recurring expense workflow changed
shashank-madan Oct 15, 2023
98de49d
delete implementation changed
shashank-madan Oct 15, 2023
efc7612
Merge pull request #34 from aditikilledar/bugfix-edit-command
aditikilledar Oct 15, 2023
363c0e2
Merge pull request #33 from aditikilledar/feature-update-add-command
aditikilledar Oct 15, 2023
f96f75b
windows install steps - review incorporated
aditikilledar Oct 15, 2023
d030382
botfather resolved
aditikilledar Oct 15, 2023
5c58401
Merge pull request #30 from aditikilledar/docu-readme.md
aditikilledar Oct 15, 2023
768b7c2
Update README.md
aditikilledar Oct 15, 2023
af06c76
Merge pull request #32 from aditikilledar/analytics_feature
shashank-madan Oct 15, 2023
101e162
Fixed typo in contributing
aditikilledar Oct 16, 2023
dc98c79
Added templates for sample ccode and pic/gif showing execution
aditikilledar Oct 16, 2023
ad47008
Added templates for sample ccode and pic/gif showing execution
aditikilledar Oct 16, 2023
d364bf6
initial commit for predict budget feature
shashank-madan Oct 16, 2023
fc61965
Merge pull request #40 from aditikilledar/docu-readme.md
srina1h Oct 16, 2023
15a2c6f
delete function refactored
shashank-madan Oct 16, 2023
b073001
helper functions refactored acc to delete modifications
shashank-madan Oct 16, 2023
efbfb94
date formatting changed
shashank-madan Oct 17, 2023
dcfbea5
added category-wise spend estimation
shashank-madan Oct 17, 2023
18a2892
added necessary helper functions
shashank-madan Oct 17, 2023
e5001c3
empty check bugfixes
shashank-madan Oct 17, 2023
af10d00
added additional checks
srina1h Oct 17, 2023
93edbee
Merge pull request #46 from aditikilledar/analytics_graph_empty_fix
shashank-madan Oct 17, 2023
3b4e8f6
adding time series plot
srina1h Oct 17, 2023
8bc63f6
incorporating changes
srina1h Oct 17, 2023
d9975b1
Merge pull request #47 from aditikilledar/time_series_analytics
shashank-madan Oct 17, 2023
e1cd97b
completed budget prediciton feature
shashank-madan Oct 17, 2023
551610d
Merge branch 'main' into enhancement-budget-predict
shashank-madan Oct 17, 2023
71194f7
Merge pull request #48 from aditikilledar/enhancement-budget-predict
srina1h Oct 17, 2023
436b91f
Resolves issue #10
shashank-madan Oct 17, 2023
ed91200
Refactored date storing format
shashank-madan Oct 17, 2023
f70bc3e
refactored get_analysis.py to use graphing.py
shashank-madan Oct 17, 2023
fa7b61a
added analytics graphs to pdf report
shashank-madan Oct 17, 2023
8ba8d51
Merge pull request #49 from aditikilledar/enhancement-budget-predict
srina1h Oct 17, 2023
e13c398
removed redundant docu from issue #1
aditikilledar Oct 17, 2023
7870a4e
code cleanup (partial)
srina1h Oct 17, 2023
24f7f62
cleanup helper.py
srina1h Oct 17, 2023
fd96fff
cleanup history.py
srina1h Oct 17, 2023
4d4107f
combined scattered docs fixing issue #1 completely.
aditikilledar Oct 17, 2023
455b811
cleanup notify
srina1h Oct 17, 2023
7c3e754
cleanup complete
srina1h Oct 17, 2023
0ab8a13
Merge pull request #51 from aditikilledar/docu-merging-scattered-docs
shashank-madan Oct 17, 2023
401599a
edge case bugfixes
shashank-madan Oct 17, 2023
ef44e2c
Merge pull request #52 from aditikilledar/code_cleanup_1
shashank-madan Oct 17, 2023
91251a7
Issues Badge done
aditikilledar Oct 17, 2023
f8bb5db
Merge branch 'main' into semantics-and-bugfixes
shashank-madan Oct 17, 2023
c3d6d47
Issues Badge done
aditikilledar Oct 17, 2023
bbc3b8a
Contributors Badge done
aditikilledar Oct 17, 2023
f59ecc2
Merge pull request #53 from aditikilledar/semantics-and-bugfixes
srina1h Oct 17, 2023
7d75f46
update title
aditikilledar Oct 17, 2023
8a7e697
Create analytics.md
srina1h Oct 18, 2023
c449e1e
Update README.md
srina1h Oct 18, 2023
aef577c
Update README.md
srina1h Oct 18, 2023
f363594
Update analytics.md
srina1h Oct 18, 2023
358045a
Update graphing.md
srina1h Oct 18, 2023
75ceebc
Merge pull request #55 from aditikilledar/analytics_docs
shashank-madan Oct 19, 2023
79b0fcc
Merge pull request #56 from aditikilledar/docu-badges-commands
srina1h Oct 19, 2023
e267dc6
bugfix in predict
shashank-madan Oct 19, 2023
36b7a94
pdf report graph alignment
shashank-madan Oct 19, 2023
8558d52
Merge branch 'semantics-and-bugfixes' of https://github.com/aditikill…
shashank-madan Oct 19, 2023
146d080
Update README.md
shashank-madan Oct 19, 2023
8444940
Update add.md
shashank-madan Oct 19, 2023
21ad9f7
Update budget.md
shashank-madan Oct 19, 2023
5c71e02
Update budget_delete.md
shashank-madan Oct 19, 2023
97c63c7
Update budget_update.md
shashank-madan Oct 19, 2023
6998de2
Update code.md
shashank-madan Oct 19, 2023
69a6e88
Update delete.md
shashank-madan Oct 19, 2023
a6fd36d
Merge pull request #57 from aditikilledar/semantics-and-bugfixes
aditikilledar Oct 19, 2023
ef7531d
Create python-app.yml
aditikilledar Oct 19, 2023
0ba28ea
Update python-app.yml
aditikilledar Oct 19, 2023
909f0a4
Update python-app.yml
aditikilledar Oct 19, 2023
6e8df0f
Added code cov
aditikilledar Oct 19, 2023
a7cbf10
Update python-app.yml with codecov secret
aditikilledar Oct 19, 2023
e6454e3
updated code documentation files
shashank-madan Oct 19, 2023
7038272
adding tests on old template
srina1h Oct 19, 2023
a8589f7
Merge pull request #58 from aditikilledar/workflow-1-test
srina1h Oct 19, 2023
d3a14a4
minor spelling add.md
srina1h Oct 19, 2023
f4f7491
Update requirements.txt with mock
aditikilledar Oct 19, 2023
1266995
Update python-app.yml with codecov secret
aditikilledar Oct 19, 2023
5cc29b5
Merge pull request #59 from aditikilledar/docu-badges-commands
srina1h Oct 19, 2023
3129c26
Update README.md
aditikilledar Oct 19, 2023
99e72d4
fixed add and budget tests
srina1h Oct 19, 2023
f2da625
Initial rubric updates; video and testing part needs to be updated.
aditikilledar Oct 19, 2023
c433b69
Added rubric, TODO add sustainiblity
aditikilledar Oct 19, 2023
d99eeb4
TODO: add sustainablity report. video. DONE: basic rubric
aditikilledar Oct 19, 2023
6a32864
Update Proj2-selfassessment-2023.md
aditikilledar Oct 19, 2023
3a95159
Update Proj2-SelfAssessmentRubric.md
aditikilledar Oct 19, 2023
2e1d1c1
Update Proj2-SelfAssessmentRubric.md
aditikilledar Oct 19, 2023
b1d150e
Merge pull request #62 from aditikilledar/Project2-Submission
aditikilledar Oct 20, 2023
0590347
fixing tests
srina1h Oct 20, 2023
592389a
Merge pull request #61 from aditikilledar/fixing_failed_tests_workflow
srina1h Oct 20, 2023
25e16b6
Create whats-new.md
srina1h Oct 20, 2023
5387c13
adding graph picture
srina1h Oct 20, 2023
a74a0f9
Update whats-new.md partial
srina1h Oct 20, 2023
36ecd6f
Update README.md
srina1h Oct 20, 2023
2e33481
Added marketing video
aditikilledar Oct 20, 2023
cb55b18
Add marketing vid to README
aditikilledar Oct 20, 2023
9f12d60
Update README.md with marketing video link
aditikilledar Oct 20, 2023
cb8f42c
Update whats-new.md
srina1h Oct 20, 2023
271d49b
Update README.md with how to use docu
aditikilledar Oct 20, 2023
7cc00fe
Update README.md
aditikilledar Oct 20, 2023
80602dc
Merge pull request #66 from aditikilledar/video
aditikilledar Oct 20, 2023
10f8a85
Update README.md
srina1h Oct 20, 2023
86d6b6e
Merge pull request #65 from aditikilledar/whats-new-docu
shashank-madan Oct 20, 2023
b8f005a
Update README.md
aditikilledar Oct 20, 2023
06f5f46
Update README.md
aditikilledar Oct 20, 2023
a52d318
Update README.md
aditikilledar Oct 20, 2023
387dac4
Update README.md
aditikilledar Oct 20, 2023
1897e80
Update README.md
aditikilledar Oct 20, 2023
46ef198
Update README.md
aditikilledar Oct 20, 2023
105bd1c
Merge pull request #67 from aditikilledar/future-work
shashank-madan Oct 20, 2023
7731904
Update README.md
aditikilledar Oct 20, 2023
16b84a6
Update Proj2-SelfAssessmentRubric.md
shashank-madan Oct 20, 2023
1f30e7f
adding code coverage
srina1h Oct 20, 2023
e0ff67b
updating code coverage
srina1h Oct 20, 2023
cf21967
Update python-app.yml
srina1h Oct 20, 2023
39a1de7
documentation update
shashank-madan Oct 20, 2023
1ad7813
removed old obsolete docu
shashank-madan Oct 20, 2023
69d04c8
Update python-app.yml
srina1h Oct 20, 2023
392728b
Merge pull request #70 from aditikilledar/docu-updates-latest
aditikilledar Oct 20, 2023
62e932b
Update python-app.yml
srina1h Oct 20, 2023
590be19
Update python-app.yml
srina1h Oct 20, 2023
830749d
Merge pull request #69 from aditikilledar/checking_code_coverage
srina1h Oct 20, 2023
b9ff295
Update README.md
aditikilledar Oct 20, 2023
67f5d1d
Update README.md
aditikilledar Oct 20, 2023
b2fcde0
Update README.md
aditikilledar Oct 20, 2023
ea1059b
Update Proj2-SelfAssessmentRubric.md
aditikilledar Oct 20, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Bug Issue Reports
about: Create a bug report to help DollarBot improve!
title: 'Bug in <feature>: describe the bug in a few words>'
labels: 'bug'
assignees: ''

---


10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/docu-template.md
Original file line number Diff line number Diff line change
@@ -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: ''

---


8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Enhancement Suggestions
about: Have cool feature enhancement ideas? Share here!
title: 'Enhancement: XYZ in ABC feature'
labels: 'enhancement'
assignees: ''

---
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/issue-task-template.md

This file was deleted.

8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/other-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: Other Issue Reports
about: Don't see your issue above? Tell us here.
title: 'Issue in <feature>: describe the issue in a few words>'
labels: ''
assignees: ''

---
45 changes: 45 additions & 0 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -133,3 +133,4 @@ dmypy.json

# Generated files
expense_record.json
user.properties
108 changes: 108 additions & 0 deletions A_Project2_Submission/Proj2-SelfAssessmentRubric.md
Original file line number Diff line number Diff line change
@@ -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.| <a href="https://www.canva.com/design/DAFxwU4ABIg/LqMkLeGUBhC__JmWmdkFiQ/watch?utm_content=DAFxwU4ABIg&utm_campaign=designshare&utm_medium=link&utm_source=editor">Click here for a video overview!!</a> | 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|
2 changes: 2 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
100755 → 100644
Original file line number Diff line number Diff line change
@@ -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 -

Expand Down Expand Up @@ -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. <br>
Expand Down Expand Up @@ -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. <br>
* 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.
Expand Down
68 changes: 68 additions & 0 deletions Developer_ReadMe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# For Developers: From the Developers of DollarBot

<details open="open">
<summary>Table of Contents</summary>
<ol>
<li><a href="#function-documentation">Function Documentation</a></li>
<li><a href="#testing">Testing</a></li>
<li><a href="#code-coverage">Code Coverage</a></li>
<li><a href="#license">License</a></li>
<li><a href="#code-documentation">Code Documentation</a></li>
<li><a href="#how-to-contribute">How to Contribute</a></li>
<li><a href="#future-roadmap">Future RoadMap</a></li>
</ol>
</details>

## Code Documentation by Functionality

For a detailed explanation of the code, follow the links below:

<ol>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/code.md">Main Code File</a></li>
<b> Features: </b>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/add.md">Add</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/budget_delete.md">Budget Delete</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/budget_update.md">Budget Update</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/budget_view.md">Budget View</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/delete.md">Delete</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/display.md">Display</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/estimate.md">Estimate</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/graphing.md">Graphing</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/helper.md">Helper</a></li>
<li><a href="https://github.com/aditikilledar/dollar_bot_SE23/blob/main/docs/history.md">History</a></li>
</ol>


## 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.
26 changes: 0 additions & 26 deletions Proj2-SelfAssessmentRubric.md

This file was deleted.

Binary file removed Project Iteration 2 - New Features.pdf
Binary file not shown.
Loading