A Python-based Telegram bot leveraging Telethon. This project uses a virtual environment (venv) and a .env file to store sensitive configuration like API credentials.
Develop a Telegram bot using Telethon to retrieve information about posts (new and historical), log them to the console, and save them to a CSV file.
**Prerequisites**
**Prerequisites**
Python 3.8+ installed
Python 3.8+ installed
Access to a terminal/command prompt
Access to a terminal/command prompt
Git (optional, for cloning)
Git (optional, for cloning)
**Getting Telethon API credentials**
To use Telethon, you need:
API_ID (an integer)
**Getting Telethon API Credentials**
API_HASH (a 32-character hex string)
Create a Telegram App
Follow these steps to obtain them:
**Create a Telegram App**
Go to: https://my.telegram.org
Go to: https://my.telegram.org
Log in with your Telegram account
Log in with your Telegram account
Navigate to "API development tools" (or "Create new application" if prompted)
Navigate to “API development tools” (or “Create new application” if prompted)
Create a new application:
Create a new application:
App title: any name
App title: any name
Short name: a short identifier
Short name: a short identifier
After saving, you will see:
After saving, you will see:
API development tools: API_ID
API_ID (integer)
API_HASH
API_HASH (32-character hex string)
Save credentials securely
Save Credentials Securely
Note down the API_ID (integer) and API_HASH (string).
Note down the API_ID and API_HASH and do not share them publicly.
**Environment file (env)**
Environment File (.env)
Create a file named .env at the project root.
Add the following variables (replace with your actual values):
Create a file named .env at the project root
Add the following variables (replace with your actual values)
API_ID=your_api_id_here
API_ID=your_api_id_here
API_HASH=your_api_hash_here
API_HASH=your_api_hash_here
BOT_TOKEN=your_bot_token_if_you_use_one (optional, if applicable)
SESSION=session_name
INVITE_LINK=invite_link_of_channel_
Tips:
Keep .env out of version control by adding it to .gitignore.
SESSION is the session name used by Telethon (e.g., “telegram_bot”).
INVITE_LINK is a private/public invite link or join link for the target channel.
**Setting up a virtual environment (venv)**
**Setting Up a Virtual Environment (venv)**
1) Create Virtual Enviroment
Create Virtual Environment
macOS/Linux:
python3 -m venv venv
python3 -m venv venv
2) Activate the virtual environment
Windows (CMD/PowerShell):
source .venv/bin/activate
py -m venv venv
Activate the Virtual Environment
macOS/Linux:
source venv/bin/activate
Windows (CMD):
venv\Scripts\activate
Windows (PowerShell):
.\venv\Scripts\Activate.ps1
**Install Dependencies**
3)Install dependencies
pip install -r requirements.txt
pip install -r requirements.txt
**Running the project**
Ensure the environment is loaded
On activation, you should see the venv name in your shell prompt.
Run the program script
python services/telegram_listener.py
**Running the Project**
Ensure the virtual environment is activated
Confirm .env is present with correct values
**Verify the bot is running**
Check console output for post messages
Run the program script
python services/telegram_listener.py
Verify the Bot Is Running
Check console output for post messages (new and historical)
Confirm CSV file is created/updated with captured post data
