Example-example / README.md
AkshayHuggingFace's picture
Telegram bot
f2c1750 verified
|
raw
history blame
3.06 kB

PROJECT TITLE

Task Manager Telegram bot: An AI-powered Telegram bot that helps users add, edit, list, and delete tasks seamlessly using natural language or commands.


PROJECT DESCRIPTION:

Task Manager Telegram Bot is an AI-powered Telegram bot designed to help users manage their tasks efficiently. It allows users to:

  • Add new tasks using commands or free text.
  • Edit existing tasks with ease.
  • List all current tasks in an organized format.
  • Delete tasks individually with confirmation.
  • Keep track of task history and previous conversations.
  • Interact naturally using both commands and conversational language.

TECHNOLOGIES USED:

  • PYTHON: The core programming language used to build the Telegram bot and implement all task management functionalities.

  • PYTHON-TELEGRAM-BOT: A Python library used to interact with the Telegram Bot API for sending and receiving messages.

  • SQLALCHEMY & SQLITE: Used for storing user tasks and chat history in a lightweight relational database.

  • GOOGLE GEMINI (via gen-ai): Provides AI-powered natural language understanding for interpreting free-text task commands and generating smart responses.

  • 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.


HOW TO GET TELEGRAM TOKEN:

  • Open Telegram and search for BotFather.
  • Start a chat with BotFather using the /start command.
  • Create a new bot using the /newbot command.
  • Follow the prompts to provide a name and username for your bot.
  • After successful creation, BotFather will give you a bot token.

HOW TO INSTALL AND RUN PROJECT:

  • Ensure you have Python installed on your system.
  • Clone this repository to your local machine.
      git clone <repository>
    
  • Open the project folder in your preferred code editor (e.g., VS Code). -Create a .env file in the root directory to store your Gemini API key:
        API_KEY=your_gemini_api_key
        TELEGRAM_BOT_KEY=your_telegram_token
    
  • Navigate to the project directory in your terminal.
  • Create virtual environment and activate it:
        python -m venv venv
        venv\Scripts\activate            
    
  • Install the dependancies:
        pip install -r requirements.txt
    
  • Run the application:
        python echobot.py
    

HOW TO USE THE PROJECT:

  • Open Telegram and search for your bot by its username.

  • Start a chat with the bot by clicking Start.

  • You can interact with the bot in two ways:

    • Commands: Use predefined commands like /newtask, /listtask, /edittask, /deletetask to manage your tasks.
    • 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.
  • The bot will respond with confirmations, task lists, or error messages as needed.