brucewzj99/tele-tracker

A python telegram bot to help track daily expenses onto google sheet

Tele-Tracker Bot

A python telegram bot to help track daily expenses onto google sheet

Release Notes

You can find the release notes over here

Table of Contents

• Getting Started (Users)
• Getting Started (Developers)
• Usage
• Contributing
• License
• Contact

Getting Started (Users)

1. Access the bot on telegram
2. Use the /start command and follow the instructions given.
3. Remember to edit the Dropdown sheet on Google Sheet to get started.
4. Happy using!

Getting Started (Developers)

Prerequisites

1. Set up Google Sheet API
2. Set up Firebase Realtime Database / or use SQLite3
3. Retrieve your service accounts for both Google Services and put it under the account folders as service_account.json & firebase_account.json
4. Retrieve your database url and set it under .env
5. Set up telegram bot via BotFather
6. Retrieve your bot API token and set it under .env

Installation

1. Clone the repo and run to get required dependencies

pip install -r requirements.txt

2. Run

python3 main.py

Usage

/start - Start the bot and configure your Google Sheet for tracking expenses and other entries.

/config - Update your Google Sheet settings or configure quick settings for adding transport and other entries.

/addentry - Add a new entry to your expense tracking system.

/addtransport - Quickly add a new transport entry to your expense tracker.

/addothers - Quickly add another type of entry to your expense tracker.

/addincome - Add a new entry to your income.

/retrievetransaction - Retrieve a transaction from past date.

/cancel - Cancel the previous conversation with the bot and start fresh.

/help - Show help message

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue or work on issues that are currently open. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Bruce Wang: [email protected]

LinkedIn: https://www.linkedin.com/in/brucewzj/

Project Link: https://github.com/brucewzj99/tele-tracker

tele-tracker's Issues

add /help page

• add a help command to introduce how to get started

push new features to users

• write a function to send about new updates to user
• write a function to update google sheet with new features

recurring transaction

• allow users to add recurring transaction
• transaction will automatically be added by monthly/yearly basis?
• inform users when such transaction are added

budgeting notification

• add a budgeting google sheet page
• sent notification when users spent is reaching budget for the day
• reminders?

allow negative entry

• allow prices to be negative

wiki page: how to use/set up

• write a wiki page on instruction on how to use and set up the bot

retrieve overview

retrieve overview transaction

migrate to cloud hosting

• move bot to use webhooks instead of polling
• move to host on cloud

add income commands

• allow users to quickly add income via telegram chat bot

utilize simplygo node api

• auto adding of simply go transaction

reminders

• sent reminders at fixed interval to remind users to add their transaction

more options for /addothers

• Allows users to have more addothers function (currently max:5)
• To utilize the other rows in trackers for use in addothers
• Allow edits to addothers

retrieve past transaction

• allow users to see their past transaction

retrieve income

retrieve income field