dgram

A simple, but extensible Python implementation for the Telegram Bot API.

Both synchronous and asynchronous.

Supported Bot API version: 6.3!

Official documentation

Contents

• Getting started
• Writing your first bot
  • Prerequisites
  • A simple echo bot
• General API Documentation
  • Types
  • Methods
  • General use of the API
    • Message handlers
    • Edited Message handler
    • Channel Post handler
    • Edited Channel Post handler
    • Callback Query handlers
    • Shipping Query Handler
    • Pre Checkout Query Handler
    • Poll Handler
    • Poll Answer Handler
    • My Chat Member Handler
    • Chat Member Handler
    • Chat Join request handler
  • Inline Mode
    • Inline handler
    • Chosen Inline handler
    • Answer Inline Query
  • Additional API features
    • Middleware handlers
    • Custom filters
    • dgram
    • Reply markup
• Advanced use of the API
  • Using local Bot API Server
  • Asynchronous dgram
  • Sending large text messages
  • Controlling the amount of Threads used by dgram
  • The listener mechanism
  • Using web hooks
  • Logging
  • Proxy
  • Testing
• API conformance limitations
• Asyncdgram
• F.A.Q.
  • How can I distinguish a User and a GroupChat in message.chat?
  • How can I handle reocurring ConnectionResetErrors?
• The Telegram Chat Group
• Telegram Channel
• More examples
• Code Template
• Bots using this library

Getting started

This API is tested with Python 3.7-3.11 and Pypy 3. There are two ways to install the library:

• Installation using pip (a Python package manager):

$ pip install dgram

• Installation from source (requires git):

$ git clone https://github.com/DEV-Degram/dgram.git
$ cd dgram
$ python setup.py install

or:

$ pip install git+https://github.com/eternnoir/dgram.git

• Started Code:

import dgram

bot = dgram.dgram("YOUR_TOKEN_HERE")

@bot.message_handler(commands=['start'])
def send_welcome(message):
    bot.reply_to(message, "Welcome, dear!")

bot.polling()