Issue 61 documentation

.github/workflows/workflow.yml

@@ -0,0 +1,4 @@
+- name: Upload coverage reports to Codecov
+  uses: codecov/codecov-action@v3
+  env:
+    CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.pylintrc

@@ -0,0 +1,37 @@
+[MASTER]
+
+# Specify the maximum line length (79 is PEP 8's recommendation, but you can change it)
+max-line-length = 79
+
+[MESSAGES CONTROL]
+
+# Disable some specific warnings or errors
+disable = C0114, C0115, C0116
+
+[BASIC]
+
+# Naming style (snake_case)
+method-rgx=_*[a-z_][a-z0-9_]*$
+function-rgx=_*[a-z_][a-z0-9_]*$
+attr-rgx=_*[a-z_][a-z0-9_]*$
+
+[FORMAT]
+
+# Ensure consistent whitespace in function call
+remove-trailing-whitespace = yes
+
+# Add or remove whitespace where necessary
+single-space-after-comma = yes
+single-space-after-keywords = yes
+
+[TYPECHECK]
+
+# Enable type hints and type checking (Python 3.5+)
+init-import = yes
+ignore-mixin-members = yes
+
+[IMPORTS]
+
+# Allow wildcard imports in specific cases (e.g., __init__.py)
+allow-wildcard-with-all = yes
+

CONTRIBUTING.md

@@ -1,10 +1,10 @@
-# Contributing to MyDollarBot
+# Contributing to DollarSplitBot
 
-Follow the set of guidelines below to contribute to MyDollarBot!
+Follow the set of guidelines below to contribute to DollarSplitBot!
 
 ## 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/shonilbhide/dollar_bot/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to upload this code. Please report unacceptable behavior to csc510group32@gmail.com.
 
 Prerequistes required before starting this project:
 
@@ -41,7 +41,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/shonilbhide/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.
 
 
 * To identify the problem, give the issue a clear and informative term. <br>
@@ -70,7 +70,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/shonilbhide/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.
 
 * 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.

README.md

@@ -1,10 +1,10 @@
-# 💰 MyDollar Bot 💰
+# 💰 DollarSplitBot 💰
 
 <!-- TABLE OF CONTENTS -->
 <details open="open">
   <summary>Table of Contents</summary>
   <ol>
-    <li><a href="#why-should-you-use-dollar-bot">Why should you use Dollar Bot?</a></li>
+    <li><a href="#why-should-you-use-dollarsplitbot">Why should you use DollarSplitBot?</a></li>
     <li><a href="#check-out-the-video">Check out the video!</a></li>
     <li><a href="#what-is-new-in-this-version">What is new in this version?</a></li>
     <li><a href="#installation">Installation</a></li>
@@ -32,7 +32,7 @@
 [![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)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10015948.svg)](https://zenodo.org/records/10015948)
 [![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)
 
@@ -42,16 +42,25 @@
 
 <hr>
 
-## Why should you use MyDollar Bot?
+## Why should you use DollarSplitBot?
 
-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:
-- Add/Record new spendings
-- Display your spendings through bar graph
-- Show the sum of your expenditure for the current day/month
-- Display your spending history
-- Clear/Erase all your records
-- Edit/Change any spending details if you wish to
+"Discover a whole new level of financial clarity and fairness – where you'll never have to wonder 'Who owes me, and who do I owe?' again. Say goodbye to financial puzzles, and embrace our extended expense management system to reclaim your peace of mind!"
+
+Introducing DollarSplitBot, your trusty companion on Telegram, here to turn the mundane task of tracking your daily expenses into a breeze. This ingenious bot simplifies the process of keeping tabs on your spending, even when you're offline. But that's not all; it's also your go-to solution for managing group expenses and ensuring everyone's financial equilibrium.
+
+With just a few swift commands, DollarSplitBot empowers you to:
+
+1. **Welcome New Faces:** Add your friends to share expenses with ease.
+2. **Log Your Transactions:** Document and store your expenditures effortlessly.
+3. **Equitable Divisions:** Showcase your spending history, unraveling who owes what to whom.
+4. **Money Matters:** Keep tabs on your daily and monthly expenditure totals.
+5. **Your Financial Story:** Access your spending history at any time.
+6. **A Clean Slate:** Erase all records when it's time to start anew.
+7. **Tailored Details:** Edit any spending particulars to your liking.
+8. **Paper Trail:** Generate sleek PDF expenditure reports for a comprehensive overview.
+9. **Friendly Nudges:** Send friendly reminders via email to ensure financial settlements.
+
+DollarSplitBot: Where simplicity meets financial harmony at your fingertips.
 
 ## Check out the video!
 
@@ -105,6 +114,26 @@ A successful run will generate a message on your terminal that says "TeleBot: St
 
 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.
 
+## Configuring Email Credentials for SMTP: Sending Emails from Your Account
+
+**SMTP (Simple Mail Transfer Protocol)** is a standard protocol for sending emails. It is widely used for sending email messages from one server to another. In the code, we are using SMTP to send emails via a Gmail account. Here's how the SMTP configuration and usage work:
+
+1. **SMTP Server**: The `smtp_server` variable is set to 'smtp.gmail.com,' which is the SMTP server for Gmail. This server is responsible for sending your email messages.
+
+2. **SMTP Port**: The `smtp_port` variable is set to 587. This is the port for TLS (Transport Layer Security) encryption. Gmail uses this port for secure email communication.
+
+3. **SMTP Username**: The smtp_username variable should be set to your own Gmail email address from which you want to send the emails. Make sure to replace `your-email@gmail.com` with your actual Gmail email address in the code. This ensures that the emails will be sent from your specific Gmail account.
+
+4. **SMTP Password**: The `smtp_password` variable is set, you need to generate an "App Password". An App Password is a 16-character code that allows you to access your Gmail account without revealing your real password. To generate an App Password, follow these steps:
+
+   - Go to your Google Account settings (https://myaccount.google.com/).
+   - In the "Security" section, under "Signing in to Google", select "App Passwords".
+   - Select "Mail" and "Other (Custom name)" from the dropdown menus.
+   - Click "Generate".
+   -  Google will provide you with a 16-character App Password. Use this as your `smtp_password` in your code.
+
+By customizing these settings, you can send emails from any email account using SMTP. Just ensure you are adhering to the security guidelines provided by your email provider.
+
 ## 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:
@@ -123,34 +152,56 @@ coverage run -m pytest test/
 coverage report
 ```
 
+## Use Cases
+
+Common use cases for DollarSplitBot summarized in three points:
+
+1. **Personal Expense Tracking:**
+   - Easily log and monitor your individual daily and monthly expenses, including groceries, dining out, transportation, and entertainment.
+   - Access your spending history and totals at any time, providing valuable insights into your financial habits.
+
+2. **Group Expense Management:**
+   - Efficiently manage group expenses with friends or family members. Add participants to track shared costs and responsibilities.
+   - DollarSplitBot calculates equitable divisions, simplifying the process of determining who owes what to whom in group expenses.
+
+3. **Expense Reporting and Communication:**
+   - Generate detailed PDF expenditure reports for a comprehensive overview of your financial activity.
+   - Utilize the bot's email reminders to facilitate financial settlements and maintain harmony in shared expenses, ensuring everyone is accountable.
+
+Certainly, you can watch this video [![Demo Video](https://i9.ytimg.com/vi/aCjcT1CHAzU/mq3.jpg?sqp=COSotI0G&rs=AOn4CLD34jFIlq6GRdmTnK6p3F8O2F-Yig)](https://youtu.be/aCjcT1CHAzU) for a step-by-step guide on how to use DollarSplitBot. 
+
 ## 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.
+This project is licensed under the terms of the MIT license. Please check [License](https://github.com/shonilbhide/dollar_bot/blob/main/LICENSE) for more details.
 
 
 ## Code Documentation
 
-Checkout the [docs](https://github.com/sak007/MyDollarBot-BOTGo/tree/main/docs)
+Checkout the [docs](https://github.com/shonilbhide/dollar_bot/tree/main/docs)
 
 ## How to Contribute
 
-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)
+We would be happy to receive contributions! If you'd like to, please go through our [CONTRIBUTING.md](https://github.com/shonilbhide/dollar_bot/blob/main/CONTRIBUTING.md)
 
-For any feedback, issues, or bug reports, please create an issue [here](https://github.com/usmanwardag/dollar_bot/issues/new).
+For any feedback, issues, or bug reports, please create an issue [here](https://github.com/shonilbhide/dollar_bot/issues/new).
 
 ## 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.
+- This application can be integrated with a group chat to track expenses of a group.
+- A better model can be implemented to forecast the budgets and expenses for future.
+- Make our bot support multiple languages, and not just english so that it might be helpful in the other regions of the world.
+-  Integrate the bot with financial services, like bank APIs, for real-time expense tracking and account balance updates.
+- Implement a reminder system to notify users of recurring expenses, upcoming bills, or when they need to settle debts.
 
 ## Contributors
 <table>
   <tr>
-    <td align="center"><a href="https://github.com/usmanwardag"><img src="https://avatars.githubusercontent.com/u/8848723?v=4" width="75px;" alt=""/><br /><sub><b>Usman Khan</b></sub></a></td>
-    <td align="center"><a href="https://github.com/aakriti0fnu"><img src="https://avatars.githubusercontent.com/u/65619749?s=400&u=e7d56965d4414a95f969dbf53ed92b3e31fab610&v=4" width="75px;" alt=""/><br /><sub><b>Aakriti Aakriti</b></sub></a><br /></td>
-    <td align="center"><a href="https://github.com/sbosenc"><img src="https://avatars.githubusercontent.com/u/89551210?v=4" width="75px;" alt=""/><br /><sub><b>Suneha Bose</b></sub></a><br /></td>
-    <td align="center"><a href="https://github.com/muskan7828"><img src="https://avatars.githubusercontent.com/u/45363276?v=4" width="75px;" alt=""/><br /><sub><b>Muskan Gupta</b></sub></a><br /></td>
-    <td align="center"><a href="https://github.com/kriti0207"><img src="https://avatars.githubusercontent.com/u/89510237?v=4" width="75px;" alt=""/><br /><sub><b>Kriti Khullar</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/shonilbhide"><img src="https://avatars.githubusercontent.com/u/51792152?s=96&v=4" width="75px;" alt=""/><br /><sub><b>Shonil bhide</b></sub></a></td>
+    <td align="center"><a href="https://github.com/sakshibasapure"><img src="https://avatars.githubusercontent.com/u/40641044?v=4" width="75px;" alt=""/><br /><sub><b>Sakshi Basapure</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/rutuja-39"><img src="https://avatars.githubusercontent.com/u/59025269?v=4" width="75px;" alt=""/><br /><sub><b>Rutuja Rashinkar</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/agmalpur"><img src="https://avatars.githubusercontent.com/u/144184451?v=4" width="75px;" alt=""/><br /><sub><b>Akshada Malpure</b></sub></a><br /></td>
   </tr>
 </table>
 

TROUBLESHOOTING.md

@@ -0,0 +1,23 @@
+# Troubleshooting Guide
+
+## How to Access Your Gmail Account with an 'App Password'
+
+If you're having trouble accessing your Gmail account, you can use Google's 'App Password' solution to resolve the issue. Follow these steps to generate and use an app password:
+
+1. **Enable Two-Step Verification:**
+   - Go to your Google Account settings by visiting [Google Account](https://myaccount.google.com/).
+   - In the "Security" section, locate and select "Two-step verification."
+   - Follow the on-screen instructions to set up two-step verification for your account. This adds an extra layer of security.
+
+2. **Create an App Password:**
+   - After enabling two-step verification, navigate to your Google Account's security settings.
+   - In the "Signing in to Google" section, choose "App Passwords."
+   - Select "Mail" and "Other (Custom name)" from the respective dropdown menus.
+   - Click the "Generate" button.
+   - Google will provide you with a 16-character App Password. This password is a one-time use code that allows you to access your Gmail account without revealing your actual account password.
+
+3. **Use the App Password:**
+   - When configuring email settings or applications, use the same settings as you would for sending emails from your Gmail account.
+   - However, replace your regular password with the generated 16-character app password.
+   - This app password should be entered wherever you are prompted for your email password.
+