Home

Awesome

pytgbot - Telegram Bot API 4.6

Version 4.6.3 (stable) Join pytgbot group on telegram

Python module to access the telegram bot api.

Native python package with a pure Python interface for the Telegram Bot API.

The code is generated directly from the API documentation, meaning up-to-date code is a matter of minutes.

Recent changes

Older changes...

Are you using pytgbot?

If you're using this library to build your Telegram Bots, We'd love to know and share the bot with the world. Tell us about it - here

Check out the Who's using pytgbot wiki page to know more about what people have been building with this library.

Installation

Releases

Released versions can be found at several locations:

Latest Stable

The latest version seems to be version 4.9. For other releases you must adapt the examples below. Also check the release section, if there are newer versions available.

Python package index (recommended)
pip install pytgbot[sync]==4.9
Using a specific git version

You have to replace 289ad8c330282cadcb70309e5d08c888ab38a0f3 with the specific commit hash of the version you want.

pip install -e git://github.com/luckydonald/pytgbot.git@289ad8c330282cadcb70309e5d08c888ab38a0f3#egg=pytgbot[sync]
Manually
git clone -b v4.9 https://github.com/luckydonald/pytgbot.git
cd pytgbot
pip install -e .[sync]

Bleeding edge

To get the most current code manually

git clone https://github.com/luckydonald/pytgbot.git
cd pytgbot
python setup.py install

Updating

Note, since version 4.9 you have to add [sync].

Latest Stable

The latest version seems to be version 4.9. For other releases you must adapt the examples below. Also check the release section, if there are newer versions available.

Python package index (recommended)
pip install -U pytgbot[sync]==4.9
Using a specific git version

You have to replace 289ad8c330282cadcb70309e5d08c888ab38a0f3 with the specific commit hash of the version you want.

pip install -e git://github.com/luckydonald/pytgbot.git@289ad8c330282cadcb70309e5d08c888ab38a0f3#egg=pytgbot[sync]
Manually
cd pytgbot
git fetch
git checkout v4.9
pip install -e .[sync]

Bleeding edge

To get the most current code manually

cd pytgbot
git fetch
git checkout master
git pull
pip install -e .[sync]

Usage

from pytgbot import Bot

bot = Bot(API_KEY)

# sending messages:
bot.send_message(CHAT, "Example Text!")  # CHAT can be a @username or a id

# getting events:
for x in bot.get_updates():
	print(x)

All the functions can be found in the Bot class in the pytgbot/bot.py file. They are pythonic in small letters with underscores instead of camel case, for example getUpdates is bot.get_updates().

Documentation

You can always inspect the documentation inside the code. You can also use the python help() command in the interactive interpreter:

>>> from pytgbot import Bot
>>> help(Bot)
>>> # or
>>> help(Bot.get_updates)

Examples

Have a look into the examples folder.

In case of errors

First you should set logging to level DEBUG to see what's going on.

# add this to the first lines in your file
import logging
logging.basicConfig(level=logging.DEBUG)

If you are about to open a new issue, search the existing ones (open and closed) first. Sometimes they are already reported or even solved.

Note for maintainers of this package:

Best way to apply changes is to create a patch from the commit containing the new generated files output.

git apply --verbose --reject --no-index -C1 --whitespace=fix --ignore-space-change --ignore-whitespace --directory pytgbot/ NAME.patch
find ./pytgbot/ -type f -name '*.rej' | xargs --replace={}  --max-args=1   echo "{} {}"
find ./pytgbot/ -type f -name '*.rej' |  xargs  --replace={}  --max-args=1  bash -c 'file="{}";file="${file%.*}"; echo wiggle --replace ${file} {};'
wiggle --replace pytgbot

You may need to install wiggle: brew install wiggle See also https://stackoverflow.com/questions/4770177/git-patch-does-not-apply