..
Make sure to apply any changes to this file to README_RAW.rst as well!
.. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-logo-text_768.png?raw=true
:align: center
:target: https://python-telegram-bot.org
:alt: python-telegram-bot 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 <https://telegram.me/pythontelegrambotgroup>`_. Join us!
*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.
.. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg
:target: https://pypi.org/project/python-telegram-bot/
:alt: PyPi Package Version
.. image:: https://img.shields.io/pypi/pyversions/python-telegram-bot.svg
:target: https://pypi.org/project/python-telegram-bot/
:alt: Supported Python versions
.. image:: https://img.shields.io/badge/Bot%20API-6.3-blue?logo=telegram
:target: https://core.telegram.org/bots/api-changelog
:alt: Supported Bot API versions
.. image:: https://img.shields.io/pypi/dm/python-telegram-bot
:target: https://pypistats.org/packages/python-telegram-bot
:alt: PyPi Package Monthly Download
.. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable
:target: https://python-telegram-bot.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg
:target: https://www.gnu.org/licenses/lgpl-3.0.html
:alt: LGPLv3 License
.. image:: https://github.com/python-telegram-bot/python-telegram-bot/workflows/GitHub%20Actions/badge.svg
:target: https://github.com/python-telegram-bot/python-telegram-bot/
:alt: Github Actions workflow
.. image:: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg
:target: https://codecov.io/gh/python-telegram-bot/python-telegram-bot
:alt: Code coverage
.. image:: http://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg
:target: http://isitmaintained.com/project/python-telegram-bot/python-telegram-bot
:alt: Median time to resolve an issue
.. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968
:target: https://www.codacy.com/app/python-telegram-bot/python-telegram-bot?utm_source=github.com&utm_medium=referral&utm_content=python-telegram-bot/python-telegram-bot&utm_campaign=Badge_Grade
:alt: Code quality: Codacy
.. image:: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues
:target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge
:alt: Code quality: DeepSource
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram
:target: https://telegram.me/pythontelegrambotgroup
:alt: Telegram Group
=================
Table of contents
=================
- `Introduction`_
- `Telegram API support`_
- `Installing`_
- `Getting started`_
#. `Learning by example`_
#. `Logging`_
#. `Documentation`_
- `Getting help`_
- `Contributing`_
- `License`_
============
Introduction
============
This library provides a pure Python interface for the
`Telegram Bot API <https://core.telegram.org/bots/api>`_.
It's compatible with Python versions 3.7+. PTB might also work on `PyPy <http://pypy.org/>`_, though there have been a lot of issues before. Hence, PyPy is not officially supported.
In addition to the pure API implementation, this library features a number of high-level classes to
make the development of bots easy and straightforward. These classes are contained in the
``telegram.ext`` submodule.
A pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``. `See here for details. <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/README_RAW.rst>`_
----
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 **6.2** are supported.
==========
Installing
==========
You can install or upgrade python-telegram-bot with:
.. code:: shell
$ pip install python-telegram-bot --upgrade
Or you can install from source with:
.. code:: shell
$ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive
$ cd python-telegram-bot
$ python setup.py install
In case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:
.. code:: shell
$ git submodule update --init --recursive
---------------------
Optional Dependencies
---------------------
PTB can be installed with optional dependencies:
* ``pip install python-telegram-bot[passport]`` installs the `cryptography <https://cryptography.io>`_ library. Use this, if you want to use Telegram Passport related functionality.
* ``pip install python-telegram-bot[ujson]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.
* ``pip install python-telegram-bot[socks]`` installs the `PySocks <https://pypi.org/project/PySocks/>`_ library. Use this, if you want to work behind a Socks5 server.
===============
Getting started
===============
Our Wiki contains a lot of resources to get you started with ``python-telegram-bot``:
- `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_
- Tutorial: `Your first Bot <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-Your-first-Bot>`_
Other references:
- `Telegram API documentation <https://core.telegram.org/bots/api>`_
- `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_
-------------------
Learning by example
-------------------
We believe that the best way to learn this package is by example. Here
are some examples for you to review. Even if it is not your approach for learning, please take a
look at ``echobot.py``, it is the de facto base for most of the bots out there. Best of all,
the code for these examples are released to the public domain, so you can start by grabbing the
code and building on top of it.
Visit `this page <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/examples/README.md>`_ to discover the official examples or look at the examples on the `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Examples>`_ to see other bots the community has built.
-------
Logging
-------
This library uses the ``logging`` module. To set up logging to standard output, put:
.. code:: python
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:
.. code:: python
logger = logging.getLogger()
logger.setLevel(logging.INFO)
If you want DEBUG logs instead:
.. code:: python
logger.setLevel(logging.DEBUG)
=============
Documentation
=============
``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_.
============
Getting help
============
You can get help in several ways:
1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!
2. Report bugs, request new features or ask questions by `creating an issue <https://github.com/python-telegram-bot/python-telegram-bot/issues/new/choose>`_ or `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.
3. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.
4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.
============
Contributing
============
Contributions of all sizes are welcome. Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/.github/CONTRIBUTING.rst>`_ to get started. You can also help by `reporting bugs <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.
========
Donating
========
Occasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.
=======
License
=======
You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. 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.
Raw data
{
"_id": null,
"home_page": "https://t.me/Aaru_kun",
"name": "testestes",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "python TeleGenic bot api wrapper",
"author": "Aaru kun",
"author_email": "komirobot@proton.me",
"download_url": "https://files.pythonhosted.org/packages/2f/87/1d66980eebad23f3430b8f1de5ec7826fc664bab86739828fd50f698f396/testestes-0.4.tar.gz",
"platform": null,
"description": "..\r\n Make sure to apply any changes to this file to README_RAW.rst as well!\r\n\r\n.. image:: https://github.com/python-telegram-bot/logos/blob/master/logo-text/png/ptb-logo-text_768.png?raw=true\r\n :align: center\r\n :target: https://python-telegram-bot.org\r\n :alt: python-telegram-bot Logo\r\n\r\nWe have made you a wrapper you can't refuse\r\n\r\nWe have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!\r\n\r\n*Stay tuned for library updates and new releases on our* `Telegram Channel <https://telegram.me/pythontelegrambotchannel>`_.\r\n\r\n.. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg\r\n :target: https://pypi.org/project/python-telegram-bot/\r\n :alt: PyPi Package Version\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/python-telegram-bot.svg\r\n :target: https://pypi.org/project/python-telegram-bot/\r\n :alt: Supported Python versions\r\n\r\n.. image:: https://img.shields.io/badge/Bot%20API-6.3-blue?logo=telegram\r\n :target: https://core.telegram.org/bots/api-changelog\r\n :alt: Supported Bot API versions\r\n\r\n.. image:: https://img.shields.io/pypi/dm/python-telegram-bot\r\n :target: https://pypistats.org/packages/python-telegram-bot\r\n :alt: PyPi Package Monthly Download\r\n\r\n.. image:: https://readthedocs.org/projects/python-telegram-bot/badge/?version=stable\r\n :target: https://python-telegram-bot.readthedocs.io/en/stable/?badge=stable\r\n :alt: Documentation Status\r\n\r\n.. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg\r\n :target: https://www.gnu.org/licenses/lgpl-3.0.html\r\n :alt: LGPLv3 License\r\n\r\n.. image:: https://github.com/python-telegram-bot/python-telegram-bot/workflows/GitHub%20Actions/badge.svg\r\n :target: https://github.com/python-telegram-bot/python-telegram-bot/\r\n :alt: Github Actions workflow\r\n\r\n.. image:: https://codecov.io/gh/python-telegram-bot/python-telegram-bot/branch/master/graph/badge.svg\r\n :target: https://codecov.io/gh/python-telegram-bot/python-telegram-bot\r\n :alt: Code coverage\r\n\r\n.. image:: http://isitmaintained.com/badge/resolution/python-telegram-bot/python-telegram-bot.svg\r\n :target: http://isitmaintained.com/project/python-telegram-bot/python-telegram-bot\r\n :alt: Median time to resolve an issue\r\n\r\n.. image:: https://api.codacy.com/project/badge/Grade/99d901eaa09b44b4819aec05c330c968\r\n :target: https://www.codacy.com/app/python-telegram-bot/python-telegram-bot?utm_source=github.com&utm_medium=referral&utm_content=python-telegram-bot/python-telegram-bot&utm_campaign=Badge_Grade\r\n :alt: Code quality: Codacy\r\n\r\n.. image:: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot.svg/?label=active+issues\r\n :target: https://deepsource.io/gh/python-telegram-bot/python-telegram-bot/?ref=repository-badge\r\n :alt: Code quality: DeepSource\r\n\r\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\r\n :target: https://github.com/psf/black\r\n\r\n.. image:: https://img.shields.io/badge/Telegram-Group-blue.svg?logo=telegram\r\n :target: https://telegram.me/pythontelegrambotgroup\r\n :alt: Telegram Group\r\n\r\n=================\r\nTable of contents\r\n=================\r\n\r\n- `Introduction`_\r\n\r\n- `Telegram API support`_\r\n\r\n- `Installing`_\r\n\r\n- `Getting started`_\r\n\r\n #. `Learning by example`_\r\n\r\n #. `Logging`_\r\n\r\n #. `Documentation`_\r\n\r\n- `Getting help`_\r\n\r\n- `Contributing`_\r\n\r\n- `License`_\r\n\r\n\r\n============\r\nIntroduction\r\n============\r\n\r\nThis library provides a pure Python interface for the\r\n`Telegram Bot API <https://core.telegram.org/bots/api>`_.\r\nIt's compatible with Python versions 3.7+. PTB might also work on `PyPy <http://pypy.org/>`_, though there have been a lot of issues before. Hence, PyPy is not officially supported.\r\n\r\nIn addition to the pure API implementation, this library features a number of high-level classes to\r\nmake the development of bots easy and straightforward. These classes are contained in the\r\n``telegram.ext`` submodule.\r\n\r\nA pure API implementation *without* ``telegram.ext`` is available as the standalone package ``python-telegram-bot-raw``. `See here for details. <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/README_RAW.rst>`_\r\n\r\n----\r\nNote\r\n----\r\n\r\nInstalling both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conjunction will result in undesired side-effects, so only install *one* of both.\r\n\r\n====================\r\nTelegram API support\r\n====================\r\n\r\nAll types and methods of the Telegram Bot API **6.2** are supported.\r\n\r\n==========\r\nInstalling\r\n==========\r\n\r\nYou can install or upgrade python-telegram-bot with:\r\n\r\n.. code:: shell\r\n\r\n $ pip install python-telegram-bot --upgrade\r\n\r\nOr you can install from source with:\r\n\r\n.. code:: shell\r\n\r\n $ git clone https://github.com/python-telegram-bot/python-telegram-bot --recursive\r\n $ cd python-telegram-bot\r\n $ python setup.py install\r\n \r\nIn case you have a previously cloned local repository already, you should initialize the added urllib3 submodule before installing with:\r\n\r\n.. code:: shell\r\n\r\n $ git submodule update --init --recursive\r\n\r\n---------------------\r\nOptional Dependencies\r\n---------------------\r\n\r\nPTB can be installed with optional dependencies:\r\n\r\n* ``pip install python-telegram-bot[passport]`` installs the `cryptography <https://cryptography.io>`_ library. Use this, if you want to use Telegram Passport related functionality.\r\n* ``pip install python-telegram-bot[ujson]`` installs the `ujson <https://pypi.org/project/ujson/>`_ library. It will then be used for JSON de- & encoding, which can bring speed up compared to the standard `json <https://docs.python.org/3/library/json.html>`_ library.\r\n* ``pip install python-telegram-bot[socks]`` installs the `PySocks <https://pypi.org/project/PySocks/>`_ library. Use this, if you want to work behind a Socks5 server.\r\n\r\n===============\r\nGetting started\r\n===============\r\n\r\nOur Wiki contains a lot of resources to get you started with ``python-telegram-bot``:\r\n\r\n- `Introduction to the API <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Introduction-to-the-API>`_\r\n- Tutorial: `Your first Bot <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Extensions-%E2%80%93-Your-first-Bot>`_\r\n\r\nOther references:\r\n\r\n- `Telegram API documentation <https://core.telegram.org/bots/api>`_\r\n- `python-telegram-bot documentation <https://python-telegram-bot.readthedocs.io/>`_\r\n\r\n-------------------\r\nLearning by example\r\n-------------------\r\n\r\nWe believe that the best way to learn this package is by example. Here\r\nare some examples for you to review. Even if it is not your approach for learning, please take a\r\nlook at ``echobot.py``, it is the de facto base for most of the bots out there. Best of all,\r\nthe code for these examples are released to the public domain, so you can start by grabbing the\r\ncode and building on top of it.\r\n\r\nVisit `this page <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/examples/README.md>`_ to discover the official examples or look at the examples on the `wiki <https://github.com/python-telegram-bot/python-telegram-bot/wiki/Examples>`_ to see other bots the community has built.\r\n\r\n-------\r\nLogging\r\n-------\r\n\r\nThis library uses the ``logging`` module. To set up logging to standard output, put:\r\n\r\n.. code:: python\r\n\r\n import logging\r\n logging.basicConfig(level=logging.DEBUG,\r\n format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')\r\n\r\nat the beginning of your script.\r\n\r\nYou can also use logs in your application by calling ``logging.getLogger()`` and setting the log level you want:\r\n\r\n.. code:: python\r\n\r\n logger = logging.getLogger()\r\n logger.setLevel(logging.INFO)\r\n\r\nIf you want DEBUG logs instead:\r\n\r\n.. code:: python\r\n\r\n logger.setLevel(logging.DEBUG)\r\n\r\n\r\n=============\r\nDocumentation\r\n=============\r\n\r\n``python-telegram-bot``'s documentation lives at `readthedocs.io <https://python-telegram-bot.readthedocs.io/>`_.\r\n\r\n============\r\nGetting help\r\n============\r\n\r\nYou can get help in several ways:\r\n\r\n1. We have a vibrant community of developers helping each other in our `Telegram group <https://telegram.me/pythontelegrambotgroup>`_. Join us!\r\n\r\n2. Report bugs, request new features or ask questions by `creating an issue <https://github.com/python-telegram-bot/python-telegram-bot/issues/new/choose>`_ or `a discussion <https://github.com/python-telegram-bot/python-telegram-bot/discussions/new>`_.\r\n\r\n3. Our `Wiki pages <https://github.com/python-telegram-bot/python-telegram-bot/wiki/>`_ offer a growing amount of resources.\r\n\r\n4. You can even ask for help on Stack Overflow using the `python-telegram-bot tag <https://stackoverflow.com/questions/tagged/python-telegram-bot>`_.\r\n\r\n\r\n============\r\nContributing\r\n============\r\n\r\nContributions of all sizes are welcome. Please review our `contribution guidelines <https://github.com/python-telegram-bot/python-telegram-bot/blob/v13.x/.github/CONTRIBUTING.rst>`_ to get started. You can also help by `reporting bugs <https://github.com/python-telegram-bot/python-telegram-bot/issues/new>`_.\r\n\r\n========\r\nDonating\r\n========\r\nOccasionally we are asked if we accept donations to support the development. While we appreciate the thought, maintaining PTB is our hobby and we have almost no running costs for it. We therefore have nothing set up to accept donations. If you still want to donate, we kindly ask you to donate to another open source project/initiative of your choice instead.\r\n\r\n=======\r\nLicense\r\n=======\r\n\r\nYou may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 <https://www.gnu.org/licenses/lgpl-3.0.html>`_. 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.\r\n",
"bugtrack_url": null,
"license": "LGPLv3",
"summary": "We have made you a wrapper you can't refuse",
"version": "0.4",
"project_urls": {
"Bug Tracker": "https://github.com/Dev-Union/TeleGenic/issues",
"Changelog": "https://python-telegram-bot.readthedocs.io/en/stable/changelog.html",
"Documentation": "https://python-telegram-bot.readthedocs.io",
"Download": "https://t.me/Aaru_kun",
"Homepage": "https://t.me/Aaru_kun",
"News": "https://t.me/devs_Union",
"Source Code": "https://github.com/python-telegram-bot/python-telegram-bot"
},
"split_keywords": [
"python",
"telegenic",
"bot",
"api",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b3e5c86f7d466b48c558ae081408eda5eb57e5de092102ad2015572e2ae386f",
"md5": "a2c1e23919b10875b241f65f7260b334",
"sha256": "58f01b9f12bd9fe73609eeba4fe5a26571fd0e6bf75a0a20b7a4c65916d66d7a"
},
"downloads": -1,
"filename": "testestes-0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2c1e23919b10875b241f65f7260b334",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 429589,
"upload_time": "2023-11-29T08:17:31",
"upload_time_iso_8601": "2023-11-29T08:17:31.721738Z",
"url": "https://files.pythonhosted.org/packages/6b/3e/5c86f7d466b48c558ae081408eda5eb57e5de092102ad2015572e2ae386f/testestes-0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f871d66980eebad23f3430b8f1de5ec7826fc664bab86739828fd50f698f396",
"md5": "aa5a88d35fa0f03be615ce344c49ea1d",
"sha256": "55dc6fa768064ff08cdd6a14c02fe7037ba977dcc5e06b95b1dd2d14c91fd02b"
},
"downloads": -1,
"filename": "testestes-0.4.tar.gz",
"has_sig": false,
"md5_digest": "aa5a88d35fa0f03be615ce344c49ea1d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 482179,
"upload_time": "2023-11-29T08:17:34",
"upload_time_iso_8601": "2023-11-29T08:17:34.005509Z",
"url": "https://files.pythonhosted.org/packages/2f/87/1d66980eebad23f3430b8f1de5ec7826fc664bab86739828fd50f698f396/testestes-0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 08:17:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Dev-Union",
"github_project": "TeleGenic",
"github_not_found": true,
"lcname": "testestes"
}
JSON
