Skip to main content

We have made you a wrapper you can't refuse

Project description

python-telegram-bot-raw Logo

We have made you a wrapper you can’t refuse

We have a vibrant community of developers helping each other in our Telegram group. Join us!

Stay tuned for library updates and new releases on our Telegram Channel.

PyPi Package Version Supported Python versions Supported Bot API versions PyPi Package Monthly Download Documentation Status LGPLv3 License Github Actions workflow Code coverage Median time to resolve an issue Code quality https://img.shields.io/badge/code%20style-black-000000.svg Telegram Group IRC Bridge

Table of contents

Introduction

This library provides a pure Python, lightweight interface for the Telegram Bot API. It’s compatible with Python versions 3.6+. PTB-Raw might also work on PyPy, though there have been a lot of issues before. Hence, PyPy is not officially supported.

python-telegram-bot-raw is part of the python-telegram-bot ecosystem and provides the pure API functionality extracted from PTB. It therefore does not have independent release schedules, changelogs or documentation. Please consult the PTB resources.

Note

Installing both python-telegram-bot and python-telegram-bot-raw in conjunction will result in undesired side-effects, so only install one of both.

Telegram API support

All types and methods of the Telegram Bot API 5.0 are supported.

Installing

You can install or upgrade python-telegram-bot-raw with:

$ pip install python-telegram-bot-raw --upgrade

Or you can install from source with:

$ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
$ cd python-telegram-bot
$ python setup-raw.py install

In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:

$ git submodule update --init --recursive

Note

Installing the .tar.gz archive available on PyPi directly via pip will not work as expected, as pip does not recognize that it should use setup-raw.py instead of setup.py.

Getting started

Our Wiki contains an Introduction to the API. Other references are:

Logging

This library uses the logging module. To set up logging to standard output, put:

import logging
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')

at the beginning of your script.

You can also use logs in your application by calling logging.getLogger() and setting the log level you want:

logger = logging.getLogger()
logger.setLevel(logging.INFO)

If you want DEBUG logs instead:

logger.setLevel(logging.DEBUG)

Documentation

python-telegram-bot’s documentation lives at readthedocs.io, which includes the relevant documentation for python-telegram-bot-raw.

Getting help

You can get help in several ways:

  1. We have a vibrant community of developers helping each other in our Telegram group. Join us!

  2. In case you are unable to join our group due to Telegram restrictions, you can use our IRC channel.

  3. Report bugs, request new features or ask questions by creating an issue or a discussion.

  4. Our Wiki pages offer a growing amount of resources.

  5. You can even ask for help on Stack Overflow using the python-telegram-bot tag.

Contributing

Contributions of all sizes are welcome. Please review our contribution guidelines to get started. You can also help by reporting bugs.

License

You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL-3. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don’t have to be.

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

python-telegram-bot-raw-13.2.tar.gz (233.7 kB view hashes)

Uploaded Source

Built Distribution

python_telegram_bot_raw-13.2-py3-none-any.whl (336.0 kB view hashes)

Uploaded Python 3

Supported by

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