Community-based extensions for the python-telegram-bot library.

Table of contents

• Introduction
• Installing
• Getting help
• Contributing
• License

Introduction

This library provides extensions for the python-telegram-bot library written and maintained by the community of PTB users.

Installing

Because this library is subject to more frequent changes than PTB, it is not available via PyPi. You can still install it via pip:

$ pip install git+https://github.com/python-telegram-bot/ptbcontrib.git@main

If you want to use an extension that has some special requirements, you can install them on the fly as e.g.

$ pip install "ptbcontrib[extension1,extension2] @ git+https://github.com/python-telegram-bot/ptbcontrib.git@main"

Or you can install from source with:

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

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. Report bugs, request new features or ask questions by creating an issue.

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.