Tele-Tracker Bot

A python telegram bot to help track daily expenses onto google sheet, hosted on Vercel using Flask.

Version 1 was hosted locally with a different version of python-telegram-bot

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)

Step 1

• Fork the repo and run the code below to installed the required dependencies

pip install -r requirements.txt

• Install ngrok

Step 2

• Go to Google Cloud Platform
• Set up Google Sheet API, download service account key
• Retrieve Google Sheet API email
• Set up Firebase Realtime Database, download service account key
• Retrieve your firebase database url
• Set up telegram bot via BotFather
• Insert all of them into .env as follows, you can use py dotenv or set it as env variable in your venv

BOT_TOKEN=your_bot_token
DATABASE_URL=firebase_url
GOOGLE_API_EMAIL=google_api_email
FIREBASE_JSON=service_account_key
GOOGLE_JSON=service_account_key

Step 3

• Run ngrok

ngrok http 5000

• Copy the link, it should look something like this 'https://.ap.ngrok.io'
• Set up web hook by opening this link:

https://api.telegram.org/bot<bot_token>/setwebhook?url=https://<address>.ap.ngrok.io/webhook

• You should see this:

{"ok":true,"result":true,"description":"Webhook was set"}

• Proceed to project directory and run:

python3.9 test.py

Usage

/start - Initialize and Configure Sheet

/config - Update Sheet Settings

/addentry - Add Expense Entry

/addtransport - Quick Add Transport Entry

/addothers - Quick Add Other Entry

/addincome - Add Income Entry

/retrievetransaction - Retrieve transaction from dates

/cancel - Cancel Conversation

/help - Show Help

Contributing

If you want to contribute or 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 ⭐! 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 for more information.

Contact

Bruce Wang: [email protected]

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

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