AkshayHuggingFace commited on
Commit
dfc4be1
·
verified ·
1 Parent(s): f2c1750

Create Readme

Browse files
Files changed (1) hide show
  1. README.md +6 -73
README.md CHANGED
@@ -1,73 +1,6 @@
1
- # PROJECT TITLE
2
- **Task Manager Telegram bot:** An AI-powered Telegram bot that helps users add, edit, list, and delete tasks seamlessly using natural language or commands.
3
-
4
- ---
5
-
6
- ### PROJECT DESCRIPTION:
7
- Task Manager Telegram Bot is an AI-powered Telegram bot designed to help users manage their tasks efficiently. It allows users to:
8
-
9
- - Add new tasks using commands or free text.
10
- - Edit existing tasks with ease.
11
- - List all current tasks in an organized format.
12
- - Delete tasks individually with confirmation.
13
- - Keep track of task history and previous conversations.
14
- - Interact naturally using both commands and conversational language.
15
-
16
- ---
17
-
18
- ### TECHNOLOGIES USED:
19
-
20
- - **PYTHON:** The core programming language used to build the Telegram bot and implement all task management functionalities.
21
-
22
- - **PYTHON-TELEGRAM-BOT:** A Python library used to interact with the Telegram Bot API for sending and receiving messages.
23
-
24
- - **SQLALCHEMY & SQLITE:** Used for storing user tasks and chat history in a lightweight relational database.
25
-
26
- - **GOOGLE GEMINI (via gen-ai):** Provides AI-powered natural language understanding for interpreting free-text task commands and generating smart responses.
27
-
28
- - **GOOGLE ADK AGENT:** Used to create an intelligent agent that maps user messages to task management actions, enabling context-aware task handling and conversational AI capabilities.
29
-
30
- ---
31
- ### HOW TO GET TELEGRAM TOKEN:
32
- - Open Telegram and search for BotFather.
33
- - Start a chat with BotFather using the /start command.
34
- - Create a new bot using the /newbot command.
35
- - Follow the prompts to provide a name and username for your bot.
36
- - After successful creation, BotFather will give you a bot token.
37
-
38
- ---
39
-
40
- ### HOW TO INSTALL AND RUN PROJECT:
41
- - Ensure you have Python installed on your system.
42
- - Clone this repository to your local machine.
43
- ```bash
44
- git clone <repository>
45
- - Open the project folder in your preferred code editor (e.g., VS Code).
46
- -Create a .env file in the root directory to store your Gemini API key:
47
- ```bash
48
- API_KEY=your_gemini_api_key
49
- TELEGRAM_BOT_KEY=your_telegram_token
50
- - Navigate to the project directory in your terminal.
51
- - Create virtual environment and activate it:
52
- ```bash
53
- python -m venv venv
54
- venv\Scripts\activate
55
- - Install the dependancies:
56
- ```bash
57
- pip install -r requirements.txt
58
- - Run the application:
59
- ```bash
60
- python echobot.py
61
- -----
62
- ### HOW TO USE THE PROJECT:
63
-
64
- - Open Telegram and search for your bot by its username.
65
-
66
- - Start a chat with the bot by clicking Start.
67
-
68
- - You can interact with the bot in two ways:
69
- - Commands: Use predefined commands like /newtask, /listtask, /edittask, /deletetask to manage your tasks.
70
- - Free text: Simply type messages like “remind me to buy milk” or “delete my meeting task”, and the bot will understand and perform the action.
71
- - The bot will respond with confirmations, task lists, or error messages as needed.
72
- ---
73
-
 
1
+ ---
2
+ title: Telegram Bot
3
+ sdk: streamlit
4
+ short_description: Telegram bot space
5
+ ---
6
+ Has telegram bot code