Skip to main content

A Telegram broadcast utility package with multiple database backends

Project description

🛰️ py-telecast

A lightweight and plug-and-play broadcast module for Python Telegram Bots using python-telegram-bot v20+. Developed by Manji Devs, this module supports:

  • JSON (default)
  • SQLite
  • MongoDB

Simple. Powerful. Flexible.

✨ Features

  • 📣 Broadcast any message (text, media, buttons, hyperlinks)
  • 📥 Supports reply-to-message for broadcasting
  • 👤 User database with JSON / SQLite / MongoDB backends
  • 🧠 Smart message formatting (Markdown & buttons preserved)
  • 🛡️ Sudo-only broadcasting
  • 📊 Stats report after broadcast

🔧 Installation

pip install py-telecast

Requirements: Python 3.10+ and python-telegram-bot>=20.6

🚀 Quick Start

1. Basic Setup (main.py)

from telegram.ext import Application
from py_telecast import init_broadcast

app = Application.builder().token("YOUR_BOT_TOKEN").build()

init_broadcast(
    app,
    sudo_users=[123456789],  # required
    db_type="json",          # json (default) | sqlite | mongo
    db_url=None              # optional for mongo: "mongodb+srv://..."
)

app.run_polling()

2. Broadcasting

  1. Reply to any message with:
    /broadcast
    
  2. Bot will show a preview with confirmation buttons
  3. After confirmation, sends to all users with stats:
    ✅ Broadcast completed.
    ◇ Total Users: 10
    ◇ Successful: 9
    ◇ Blocked Users: 1
    ◇ Deleted Accounts: 0
    ◇ Unsuccessful: 0
    

🛠️ Supported DB Backends

Type Configuration
JSON Default (no config needed)
SQLite db_type="sqlite"
MongoDB db_type="mongo", db_url="mongodb+srv://..."

📁 Requirements

Core Dependencies:

  • python-telegram-bot>=20.6

Optional (for MongoDB):

  • pymongo>=4.6.3

🧩 Integration Tips

  1. Works seamlessly with existing PTB bots
  2. Automatic database structure creation
  3. Logs indicate active backend during startup
  4. All broadcast attempts are logged with timestamps
  5. Supports both polling and webhook setups

🌐 Links

📄 License

MIT License © 2023 Manji Devs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytelecast-0.1.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytelecast-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file pytelecast-0.1.0.tar.gz.

File metadata

  • Download URL: pytelecast-0.1.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pytelecast-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b5105650d6156eedb94eb7d1463d20f07988b00298e7b9febd1bddf1a1f53ffc
MD5 a5abc79dec683e0b8190f5a07381cf12
BLAKE2b-256 ebf4f9566e3b8d5349a26cf1b925ea22c31b7ef1d16b990d937df6890d983793

See more details on using hashes here.

File details

Details for the file pytelecast-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pytelecast-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for pytelecast-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a54fc6014ea84ed7e22407bd9d3aa72cb5342cbce9c1af04ba7fee67dae3df70
MD5 57a8837cdf7627d9b765694ac1dca35b
BLAKE2b-256 8bfedb94a188bd4879500f2e1a37c19d925cface80d81e172467782ad8fd50bb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page