Checkout our video :: Introduction :: New Features :: Installation Guide :: Testing :: Connect with authors :: TechnologyStack :: Use Cases

🤖 Welcome to MyExpenseBot 5.0 - Unleash the Power of Financial Wizardry on Telegram! 🎉

MyExpenseBot has undergone a major transformation in Version 5.0, introducing groundbreaking features to redefine your financial experience. Explore the exciting enhancements that make managing your finances easier and more visually engaging.

Effortlessly manage group expenses with the newly added feature. This includes the ability to add, and view expenses within a group setting, streamlining the process of collaborative financial tracking.

Dive into a world of visual data representation with stunning pie charts and bar graphs. Visualize your income, expenses, and group expenses like never before, gaining deeper insights into your financial landscape.

MyExpenseBot now supports 17 additional currencies, offering you a diverse range of choices for your transactions. Benefit from lightning-fast local caching, ensuring swift currency value retrieval and a seamless user experience.

Bid farewell to future-dated inputs for income and expenditure. MyExpenseBot 5.0 introduces Time Travel Protection, ensuring that your financial records stay rooted in the present.

Enjoy a faster and more responsive MyExpenseBot with the implementation of Local JSON Caching. This enhancement drastically reduces API calls, providing lightning-fast currency value retrieval for a smoother user experience.

The journey of MyExpenseBot continues as we explore avenues for further improvements and enhancements. Check our issue list to discover ongoing tasks, proposed enhancements, and future plans to refine MyExpenseBot for an even better user experience.

The MyExpenseBot project leverages the following technologies:

• Python 3.12: Utilized as the primary programming language for bot development.
• Shell Scripting: Employed for automation and running project-related scripts.

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

1. Clone this Repository:

  git clone https://github.com/NCSU-Group70-CSC505-SE-Fall-23/MyExpenseBot.git

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

3. Create Your Telegram Bot:

• Search for "BotFather" in Telegram.
• Use /newbot to create a new bot.
• Follow instructions, get a TOKEN.

4. Update TOKEN in user.properties:

• Open user.properties, update TOKEN.

5. Run the Telegram Bot:

./run.sh (or) bash run.sh (or) sh run.sh 

6. Paste the Telegram API token when prompted.

7. A successful run will display "TeleBot: Started polling."

We use pytest to perform testing on all unit tests together. The command needs to be run from the home directory of the project. The command is:

python -m pytest test/

Code coverage 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

Imagine you're on a trip with friends or colleagues, and you want to keep track of all travel-related expenses. MyExpenseBot makes it effortless to log transportation costs, accommodation expenses, dining bills, and other travel expenditures. It helps in managing and splitting expenses among the travel group, ensuring everyone stays informed about the collective spending.

For freelancers managing multiple clients or projects, organizing income streams is crucial. MyExpenseBot can serve as a valuable tool to record various sources of income, categorize payments, and generate reports for each client or project. It simplifies financial tracking for freelancers, aiding in better invoicing and financial planning.

• Title: 'Track My Income and Expense'

• Version: '5.0.1'

• Description: 'An easy-to-use Telegram Bot to track everyday income and expenses'

• Authors (Iteration 5): Nisarg, Chaitanya, Mitesh, Aniruddha

• Authors (Iteration 4): Anvitha, Nainisha, Vaishnavi

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

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

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