Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luckydonald/pytgbot
python module to access the telegram bot api.
https://github.com/luckydonald/pytgbot
bot pytgbot python python-3 python3 python34 python35 python36 pythonic telegram telegram-bot-api
Last synced: about 1 month ago
JSON representation
python module to access the telegram bot api.
- Host: GitHub
- URL: https://github.com/luckydonald/pytgbot
- Owner: luckydonald
- License: mit
- Created: 2015-06-24T18:59:44.000Z (over 9 years ago)
- Default Branch: release
- Last Pushed: 2024-02-16T09:59:54.000Z (11 months ago)
- Last Synced: 2024-12-09T14:52:48.214Z (about 1 month ago)
- Topics: bot, pytgbot, python, python-3, python3, python34, python35, python36, pythonic, telegram, telegram-bot-api
- Language: Python
- Size: 8.43 MB
- Stars: 66
- Watchers: 8
- Forks: 16
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pytgbot - Telegram Bot API [`5`.`7`](https://core.telegram.org/bots/api)
### Version [5.7 (stable)](https://github.com/luckydonald/pytgbot/blob/master/CHANGELOG.md#changelog) [](https://telegram.me/pytg_group)
###### Python module to access the telegram bot api.
Native python package with a pure Python interface for the [Telegram Bot API](https://core.telegram.org/bots).
> The code is generated directly from the API documentation, meaning up-to-date code is a matter of minutes.
# Recent changes
- Updated with official API changes
[Older changes...](CHANGELOG.md)
# 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](https://github.com/luckydonald/pytgbot/wiki/Who's-using-pytgbot%3F)**
Check out the [Who's using pytgbot](https://github.com/luckydonald/pytgbot/wiki/Who's-using-pytgbot%3F) wiki page to know more about what people have been building with this library.
# Installation
### Releases
Released versions can be found at several locations:
- The [python package index](https://pypi.org/project/pytgbot/#history) (`pip install`),
- on GitHub in the [release section](https://github.com/luckydonald/pytgbot/releases)
- and in the git files as regular tags.
#### Latest Stable
The [latest version](#releases) seems to be version `4.9.1`. For other releases you must adapt the examples below.
##### Python package index (recommended)
```sh
pip install pytgbot==4.9.1
```
##### Manually
```sh
git clone -b v4.9.1 https://github.com/luckydonald/pytgbot.git
cd pytgbot
python setup.py install
```
#### Bleeding edge
To get the most current code manually
```
git clone https://github.com/luckydonald/pytgbot.git
cd pytgbot
python setup.py install
```
# Updating
#### Latest Stable
The [latest version](#releases) seems to be version `4.9.1`. For other releases you must adapt the examples below.
##### Python package index (recommended)
```sh
pip install -U pytgbot==4.9.1
```
##### Manually
```sh
cd pytgbot
git fetch
git checkout v4.9.1
python setup.py install
```
#### Bleeding edge
To get the most current code manually
```
cd pytgbot
git fetch
git checkout master
git pull
python setup.py install
```
# Usage
```python
from pytgbot import Bot
API_KEY='123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11' # change this to the token you get from @BotFather
CHAT='@username' # can be a @username or a id, change this to your own @username or id for example.
bot = Bot(API_KEY)
# sending messages:
bot.send_message(CHAT, "Example Text!")
# 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](https://github.com/luckydonald/pytgbot/blob/master/pytgbot/bot.py) file.
They are pythonic in small letters with underscores instead of camel case, for example [getUpdates](https://core.telegram.org/bots/api#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:
```py
>>> from pytgbot import Bot
>>> help(Bot)
>>> # or
>>> help(Bot.get_updates)
```
## Custom servers
If you want to use a custom Telegram API server, e.g. https://telegram.rest/ it is as simple as setting `base_url` and `download_url` when creating the bot:
```py
bot = Bot(API_KEY, base_url="https://telegram.rest/bot{api_key}/{command}", download_url="https://telegram.rest/file/bot{api_key}/{file}")
```
## Examples
Have a look into the [examples](https://github.com/luckydonald/pytgbot/tree/master/examples) folder.
# In case of errors
First you should set logging to level `DEBUG` to see what's going on.
```py
# 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_