v2.0.0

Author: brucewzj99

README.md

@@ -1,8 +1,9 @@
 # Tele-Tracker Bot
-A python telegram bot to help track daily expenses onto google sheet
+A python telegram bot to help track daily expenses onto google sheet, hosted on Vercel using Flask.
+[Version 1](https://github.com/brucewzj99/tele-tracker) was hosted locally with a different version of python-telegram-bot
 
 ## Release Notes
-You can find the release notes over [here](https://github.com/brucewzj99/tele-tracker/blob/master/release_notes.md)
+You can find the release notes over [here](https://github.com/brucewzj99/tele-tracker-v2/blob/master/release_notes.md).
 
 ## Table of Contents
 - [Getting Started (Users)](#getting-started-users)
@@ -16,13 +17,13 @@ You can find the release notes over [here](https://github.com/brucewzj99/tele-tr
 1. Access the bot on [telegram](https://t.me/telefinance_tracker_bot) 
 2. Use the /start command and follow the instructions given.
 4. Remember to edit the `Dropdown` sheet on Google Sheet to get started.
-![image](https://github.com/brucewzj99/tele-tracker/assets/24997286/ddf879be-69f4-4e33-a517-3b5628055e6f)
+![image](https://github.com/brucewzj99/tele-tracker-v2/assets/24997286/bfc9a244-19d5-4521-88bd-088c87f3418c)
 5. Happy using!
 
 ## Getting Started (Developers)
 ### Step 1
 * Fork the repo and run the code below to installed the required dependencies
-```python
+``` python
 pip install -r requirements.txt
 ```
 * Install [ngrok](https://ngrok.com/download) 
@@ -34,8 +35,8 @@ pip install -r requirements.txt
 * Set up Firebase Realtime Database, download service account key
 * Retrieve your firebase database url
 * Set up telegram bot via [BotFather](https://t.me/BotFather)
-* Insert all of them into .env as follows
-```.env
+* Insert all of them into .env as follows, you can use py dotenv or set it as env variable in your venv
+``` .env
 BOT_TOKEN=your_bot_token
 DATABASE_URL=firebase_url
 GOOGLE_API_EMAIL=google_api_email
@@ -45,47 +46,45 @@ GOOGLE_JSON=service_account_key
 
 ### Step 3
 * Run ngrok
-```terminal
+``` terminal
 ngrok http 5000
 ```
 * Copy the link, it should look something like this 'https://<address>.ap.ngrok.io'
 * Set up web hook by opening this link:
-```url
+``` url
 https://api.telegram.org/bot<bot_token>/setwebhook?url=https://<address>.ap.ngrok.io/webhook
 ```
 * You should see this:
-```json
+``` json
 {"ok":true,"result":true,"description":"Webhook was set"}
 ```
 * Proceed to project directory and run:
-```python
+``` python
 python3.9 test.py
 ```
 
 ## Usage
-/start - Start the bot and configure your Google Sheet for tracking expenses and other entries.
+/start - Initialize and Configure Sheet
 
-/config - Update your Google Sheet settings or configure quick settings for adding transport and other entries.
+/config - Update Sheet Settings
 
-/addentry - Add a new entry to your expense tracking system.
+/addentry - Add Expense Entry
 
-/addtransport - Quickly add a new transport entry to your expense tracker.
+/addtransport - Quick Add Transport Entry
 
-/addothers - Quickly add another type of entry to your expense tracker.
+/addothers - Quick Add Other Entry
 
-/addincome - Add a new entry to your income.
+/addincome - Add Income Entry
 
-/retrievetransaction - Retrieve a transaction from past date.
+/retrievetransaction - Retrieve transaction from dates
 
-/cancel - Cancel the previous conversation with the bot and start fresh.
+/cancel - Cancel Conversation
 
-/help - Show help message
+/help - Show Help
 
 ## 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!
+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`)
@@ -94,7 +93,7 @@ Don't forget to give the project a star! Thanks again!
 5. Open a Pull Request
 
 ## License
-Distributed under the MIT License. See `LICENSE.txt` for more information.
+Distributed under the MIT License. See `LICENSE` for more information.
 
 ## Contact
 Bruce Wang: [email protected]

release_notes.md

@@ -4,22 +4,36 @@
 - Initial Launch
 
 ## Version 1.1.0 - Date: 21 May 2023
-### New Features
+### New Features 🆕
 - Back button
 - Added help command
 
-### Bug Fixes
+### Bug Fixes 🛠️
 - Remove 'Transport' category from others
 - Fixed others and transport row tracker
 - Fixed first row tracker
 
-### Enhancement
+### Enhancement 🔥
 - Refactor file structure
 
 ## Version 1.2.0 - Date: 24 May 2023
-### New Features (Planned deployment: 27 May 2023)
+### New Features 🆕 (Planned deployment: 27 May 2023)
 - Retrieve past transaction with /retrievetransaction command
 - Add income with /addincome command
 
-### Enhancement
-- Increase number of options for add others
+### Enhancement 🔥
+- Increase number of options for add others
+
+## Version 2.0.0 - Date 28 May 2023
+### Enhancement 🔥
+- Cloud hosting w Flask & Vercel 🎉
+- Move string to text_str.py
+
+### Bug Fix 🛠️
+- Allow negative price entry
+
+### To note ❗
+- Remove sql functions
+- python-telegram-bot library changed to 13.7
+- Move services account to environment variable
+- Please read the new README for developer