https://github.com/mscbuild/assistant_bot
🤖 Assistant Bot is a Telegram-based productivity assistant designed to streamline team communication and task tracking. It offers quick access to weekly reports, task lists, and provides an interface for users to ask questions.
https://github.com/mscbuild/assistant_bot
bot development python report task telegram-bot
Last synced: 11 months ago
JSON representation
🤖 Assistant Bot is a Telegram-based productivity assistant designed to streamline team communication and task tracking. It offers quick access to weekly reports, task lists, and provides an interface for users to ask questions.
- Host: GitHub
- URL: https://github.com/mscbuild/assistant_bot
- Owner: mscbuild
- License: mit
- Created: 2025-07-01T09:34:07.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-02T05:21:55.000Z (12 months ago)
- Last Synced: 2025-07-09T10:09:15.461Z (11 months ago)
- Topics: bot, development, python, report, task, telegram-bot
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖 Assistant Bot
## 🧠 Project Description
Assistant Bot is a Telegram-based productivity assistant designed to streamline team communication and task tracking. It offers quick access to weekly reports, task lists, and provides an interface for users to ask questions. Built with Python and the `python-telegram-bot` library, this bot simplifies team operations within Telegram, providing a menu-driven interface for intuitive interaction.
# 🗺️ Project Map (Structure)
~~~bash
assistant-bot/
├── bot.py # Main application logic
├── README.md # Project description and setup guide
├── requirements.txt # Python dependencies
├── .env # Environment variables (e.g. bot token)
├── utils/ # Helper functions (e.g. keyboards, messages)
│ └── menu.py # Main menu UI
├── handlers/ # Bot handlers
│ ├── start.py # /start command handler
│ ├── callback.py # Inline button callback logic
│ └── messages.py # Text message handler
└── LICENSE
~~~
## ✨ Features
- 📊 Weekly Report Overview
- 📋 Task List Display
- ❓ Q&A Prompting
- 🧠 Smart reply for common phrases (e.g., "tasks", "review reports")
- 🧵 InlineKeyboard navigation
### Prerequisites
- Python 3.10+
- Telegram account
- Telegram bot token (from [@BotFather](https://t.me/BotFather))
## 1.Clone the repo:
~~~bash
git clone https://github.com/yourusername/Assistant_Bot.git
cd Assistant_Bot
~~~
## 2.Create a virtual environment and activate it:
~~~bash
python -m venv venv
source venv/bin/activate # On Windows use venv\Scripts\activate
~~~
## 3. Install dependencies:
~~~bash
pip install -r requirements.txt
~~~
## 4. Set your bot token in .env:
~~~bash
BOT_TOKEN=your_token_here
~~~
## 5. Run the bot:
~~~bash
python bot.py
~~~
# 🧱 Tech Stack
- Python 3.10+
- python-telegram-bot
- dotenv (for managing environment variables)
# 📋 Checklist
- ✅ Start command handler
- ✅ Inline keyboard main menu
- ✅ Report display
- ✅ Task list generation
- ✅ Question prompt handling
- ✅ Basic natural language message recognition
- ☐ Logging integration
- ☐ Persistent storage for tasks/reports
- ☐ Unit testsStart
# 📦 What is needed for deployment
| File | Purpose |
| --------------------------- | -------------------------------------------------- |
| `Dockerfile` | Building a container for local/cloud running |
| `Procfile` | To start Heroku worker |
| `.env` | Local environment variables |
| `requirements.txt` | Installing dependencies |
| `bot.py` and other modules | Bot's main code |
# 📄 License
> MIT License