python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-06 07:50:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
aiogram is a modern and fully asynchronous framework for Telegram Bot API written in Python using asyncio
1640 commits 8 branches 124 tags 19 MiB
Find a file
Alex Root Junior 2620a6547c Rework session DI and files path wrapper
2021-12-12 18:15:36 +02:00
.github Enable Python 3.10 for tests (#719) 2021-10-06 22:49:14 +03:00
aiogram Rework session DI and files path wrapper 2021-12-12 18:15:36 +02:00
CHANGES Rework session DI and files path wrapper 2021-12-12 18:15:36 +02:00
docs [3.x] Bot API 5.5 (#777) 2021-12-12 17:21:01 +02:00
examples Webhook integration in 3.0 (#737) 2021-11-08 23:20:12 +02:00
scripts Update README and docs main page 2021-10-11 01:29:06 +03:00
tests Rework session DI and files path wrapper 2021-12-12 18:15:36 +02:00
.apiversion [3.x] Bot API 5.5 (#777) 2021-12-12 17:21:01 +02:00
.coveragerc Dev 3.x i18n & improvements (#696) 2021-09-22 00:52:38 +03:00
.editorconfig Improve .editorconfig (#658) 2021-08-05 22:25:13 +03:00
.flake8 Clean project 2019-11-15 12:17:57 +02:00
.gitignore Added ability to specify which update bot need to receive and process while using polling mode (#617) 2021-07-05 01:41:27 +03:00
.pre-commit-config.yaml Updated pre-commit hook (#681) 2021-09-07 00:32:43 +03:00
.readthedocs.yml Remove MkDocs 2021-05-13 00:13:09 +03:00
CHANGES.rst Fixed changelog formatting 2021-11-11 00:39:25 +02:00
codecov.yaml Remove compatibility with Python 3.7 2021-05-25 01:00:36 +03:00
HISTORY.rst towncrier integration (#647) 2021-08-01 19:08:03 +03:00
LICENSE Updated pre-commit hook (#681) 2021-09-07 00:32:43 +03:00
Makefile [3.x] Bot API 5.5 (#777) 2021-12-12 17:21:01 +02:00
mypy.ini Update README and docs main page 2021-10-11 01:29:06 +03:00
poetry.lock Extended MagicFilter with aiogram-specific operation (#759) 2021-11-24 06:00:37 +02:00
pyproject.toml [3.x] Bot API 5.5 (#777) 2021-12-12 17:21:01 +02:00
README.rst [3.x] Bot API 5.5 (#777) 2021-12-12 17:21:01 +02:00

README.rst 

#######
aiogram
#######

.. danger::
    This version still in development!

.. image:: https://img.shields.io/pypi/l/aiogram.svg
    :target: https://opensource.org/licenses/MIT
    :alt: MIT License

.. image:: https://img.shields.io/pypi/pyversions/aiogram.svg
    :target: https://pypi.python.org/pypi/aiogram
    :alt: Supported python versions

.. image:: https://img.shields.io/badge/Telegram%20Bot%20API-5.5-blue.svg?logo=telegram
    :target: https://core.telegram.org/bots/api
    :alt: Telegram Bot API

.. image:: https://github.com/aiogram/aiogram/workflows/Tests/badge.svg?branch=dev-3.x
    :target: https://github.com/aiogram/aiogram/actions
    :alt: Tests

.. image:: https://img.shields.io/pypi/v/aiogram.svg
    :target: https://pypi.python.org/pypi/aiogram
    :alt: PyPi Package Version

.. image:: https://img.shields.io/pypi/status/aiogram.svg
    :target: https://pypi.python.org/pypi/aiogram
    :alt: PyPi status

.. image:: https://img.shields.io/pypi/dm/aiogram.svg
    :target: https://pypi.python.org/pypi/aiogram
    :alt: Downloads

.. image:: https://img.shields.io/badge/telegram-aiogram-blue.svg
    :target: https://t.me/aiogram_live
    :alt: [Telegram] aiogram live

.. image:: https://img.shields.io/codecov/c/github/aiogram/aiogram?style=flat-square
    :target: https://app.codecov.io/gh/aiogram/aiogram
    :alt: Codecov

**aiogram** modern and fully asynchronous framework for
`Telegram Bot API <https://core.telegram.org/bots/api>`_ written in Python 3.8 with
`asyncio <https://docs.python.org/3/library/asyncio.html>`_ and
`aiohttp <https://github.com/aio-libs/aiohttp>`_.

It helps you to make your bots faster and simpler.

.. danger::

    **Breaking News:**

    *aiogram* 3.0 has breaking changes.

    It breaks backwards compatibility by introducing new breaking changes!

Features
========

- Asynchronous (`asyncio docs <https://docs.python.org/3/library/asyncio.html>`_, :pep:`492`)
- Has type hints (:pep:`484`) and can be used with `mypy <http://mypy-lang.org/>`_
- Supports `Telegram Bot API 5.3 <https://core.telegram.org/bots/api>`_
- Telegram Bot API integration code was `autogenerated <https://github.com/aiogram/tg-codegen>`_ and can be easy re-generated when API was updated
- Updates router (Blueprints)
- Finite State Machine
- Middlewares (incoming updates and API calls)
- Provides `Replies into Webhook <https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates>`_
- Integrated I18n/L10n support with GNU Gettext (or Fluent)

.. warning::

    Before start using **aiogram** is highly recommend to know how to work
    with `asyncio <https://docs.python.org/3/library/asyncio.html>`_.

    Also if you has questions you can go to our community chats in Telegram:

    - `English language <https://t.me/aiogram>`_
    - `Russian language <https://t.me/aiogram_ru>`_