v2.0.0

Author: brucewzj99

README.md

@@ -1,2 +1,104 @@
-# tele-tracker-v2
-A version 2 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](https://github.com/brucewzj99/tele-tracker/blob/master/release_notes.md)
+
+## Table of Contents
+- [Getting Started (Users)](#getting-started-users)
+- [Getting Started (Developers)](#getting-started-developers)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+## Getting Started (Users)
+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)
+5. Happy using!
+
+## Getting Started (Developers)
+### Step 1
+* Fork the repo and run the code below to installed the required dependencies
+```python
+pip install -r requirements.txt
+```
+* Install [ngrok](https://ngrok.com/download) 
+
+### 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](https://t.me/BotFather)
+* Insert all of them into .env as follows
+```.env
+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
+```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
+https://api.telegram.org/bot<bot_token>/setwebhook?url=https://<address>.ap.ngrok.io/webhook
+```
+* You should see this:
+```json
+{"ok":true,"result":true,"description":"Webhook was set"}
+```
+* Proceed to project directory and run:
+```python
+python3.9 test.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/](https://www.linkedin.com/in/brucewzj/)
+
+Project Link: [https://github.com/brucewzj99/tele-tracker](https://github.com/brucewzj99/tele-tracker)

api/index.py

@@ -0,0 +1,28 @@
+from telegram import Update
+from telegram.ext import Updater
+from flask import Flask, request, render_template
+import os
+from bot.telegram_bot import setup_handlers
+
+TOKEN = os.environ.get("BOT_TOKEN")
+app = Flask(__name__)
+updater = Updater(token=TOKEN)
+dispatcher = updater.dispatcher
+
+
+@app.route("/webhook", methods=["POST"])
+def webhook():
+    update = Update.de_json(request.get_json(), updater.bot)
+    dispatcher.process_update(update)
+    return "OK"
+
+
+@app.route("/")
+def index():
+    return render_template("app.html")
+
+
+setup_handlers(dispatcher)  # Call function to set up bot handlers
+
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=int(os.environ.get("PORT", 5000)))

api/templates/app.html

@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="x-ua-compatible" content="ie=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>Tele Tracker Bot</title>
+    <meta name="description" content="A python telegram bot to help track expenses!" />
+    <meta name="theme-color" content="#65efa4" />
+    <style>
+      *,
+      *::before,
+      *::after {
+        box-sizing: border-box;
+      }
+      html {
+        font-family: sans-serif;
+        line-height: 1.15;
+        height: 100%;
+        -webkit-text-size-adjust: 100%;
+        -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
+      }
+      body {
+        font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+          "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji",
+          "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+        font-size: 16px;
+        margin: 0;
+        line-height: 1.5;
+        height: 100%;
+        text-align: left;
+        color: #fefefe;
+        background: #212121;
+      }
+      a {
+        color:#65efa4;
+        text-decoration: none;
+      }
+      a:hover {
+        text-decoration: underline;
+      }
+      .container {
+        display: table;
+        max-width: 80%;
+        height: 100%;
+        margin: auto;
+      }
+      .child {
+        display: table-cell;
+        vertical-align: middle;
+      }
+      .title {
+        color: #65efa4;
+        font-size: 42px;
+        font-weight: 700;
+        line-height: 40px;
+        margin: 0;
+      }
+      .subtitle {
+        font-size: 18px;
+        font-weight: 500;
+        line-height: 20px;
+        margin: 16px 0;
+      }
+      .logo {
+        width: 100px; 
+        height: auto; 
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <div class="child">
+        <img src="https://github.com/brucewzj99/tele-tracker-v2/tree/master/api/templates/logo.png" alt="Logo" class="logo" />
+        <h1 class="title">tele-tracker-bot</h1>
+        <h2 class="subtitle">A python telegram bot to help track expenses!</h2>
+        <p>You can access the bot using this <a href="https://t.me/telefinance_tracker_bot">link</a>.
+        <br>For instructions on how to use the bot, please refer to the <a href="https://github.com/brucewzj99/tele-tracker-v2/wiki/Getting-Started">GitHub Wiki</a>.</p>
+        <p>If you would like to support my work, you can do so at the following links:</p>
+        <script type='text/javascript' src='https://storage.ko-fi.com/cdn/widget/Widget_2.js'></script><script type='text/javascript'>kofiwidget2.init('Support Me on Ko-fi', '#2f8a5b', 'H2H8LN59H');kofiwidget2.draw();</script>     </div>
+  </body>
+</html>

api/templates/logo.png

@@ -0,0 +1,33 @@
+from enum import Enum
+
+
+class EntryType(Enum):
+    TRANSPORT = "Transport"
+    OTHERS = "Others"
+
+
+class ConversationState(Enum):
+    (
+        SET_UP,
+        RESET_UP,
+        CONFIG_HANDLER,
+        START_DESTINATION,
+        ENTRY,
+        PRICE,
+        REMARKS,
+        CATEGORY,
+        SUBCATEGORY,
+        PAYMENT,
+        SUBPAYMENT,
+        QUICK_ADD,
+        QUICK_ADD_CATEGORY,
+        CONFIG_SETUP,
+        CONFIG_CATEGORY,
+        CONFIG_SUBCATEGORY,
+        CONFIG_PAYMENT,
+        CONFIG_SUBPAYMENT,
+        HANDLE_RETRIEVE_TRANSACTION,
+        INCOME,
+        WORK_PLACE,
+        CPF,
+    ) = range(22)

bot/__init__.py

@@ -0,0 +1,23 @@
+from bot.firebase_config import db
+
+
+# new user setup
+def new_user_setup(telegram_id, sheet_id):
+    ref = db.reference("/users/" + str(telegram_id))
+    ref.update(
+        {
+            "sheet_id": sheet_id,
+        }
+    )
+
+
+# check if user exists
+def check_if_user_exists(telegram_id):
+    ref = db.reference("/users/" + str(telegram_id))
+    return ref.get() is not None
+
+
+# get user sheet id
+def get_user_sheet_id(telegram_id):
+    ref = db.reference("/users/" + str(telegram_id) + "/sheet_id")
+    return ref.get()

bot/common.py

@@ -0,0 +1,11 @@
+import firebase_admin
+from firebase_admin import credentials
+from firebase_admin import db
+import os
+import json
+from firebase_admin.credentials import Certificate
+
+DATABASE_URL = os.getenv("DATABASE_URL")
+FIREBASE_JSON = json.loads(os.environ["FIREBASE_JSON"])
+
+firebase_admin.initialize_app(Certificate(FIREBASE_JSON), {"databaseURL": DATABASE_URL})