mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-11 18:01:04 +00:00
Update README and docs main page
This commit is contained in:
Alex Root Junior
parent
3f2bcbd8d1
commit
c3cdd75ede
6 changed files with 2236 additions and 94 deletions
12
README.md
12
README.md
|
|
@ -1,12 +0,0 @@
|
|||
# aiogram 3.0 [WIP]
|
||||
|
||||
[![\[Telegram\] aiogram live](https://img.shields.io/badge/telegram-aiogram-blue.svg?style=flat-square)](https://t.me/aiogram_live)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://pypi.python.org/pypi/aiogram)
|
||||
[](https://core.telegram.org/bots/api)
|
||||
[](https://pypi.python.org/pypi/aiogram)
|
||||
[](https://pypi.python.org/pypi/aiogram)
|
||||
[](https://pypi.python.org/pypi/aiogram)
|
||||
[](https://app.codecov.io/gh/aiogram/aiogram)
|
||||
|
||||
**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.
|
||||
80
README.rst
Normal file
80
README.rst
Normal file
|
|
@ -0,0 +1,80 @@
|
|||
#######
|
||||
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.3-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>`_
|
||||
|
|
@ -1,83 +1,4 @@
|
|||
#######
|
||||
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.3-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 <https://core.telegram.org/bots/api>`_ |api_version|
|
||||
- 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
|
||||
- Provides `Replies into Webhook <https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates>`_
|
||||
|
||||
.. 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>`_
|
||||
.. include:: ../README.rst
|
||||
|
||||
Simple usage
|
||||
------------
|
||||
|
|
|
|||
2
mypy.ini
2
mypy.ini
|
|
@ -1,5 +1,5 @@
|
|||
[mypy]
|
||||
;plugins = pydantic.mypy
|
||||
plugins = pydantic.mypy
|
||||
python_version = 3.8
|
||||
show_error_codes = True
|
||||
show_error_context = True
|
||||
|
|
|
|||
2149
poetry.lock
generated
Normal file
2149
poetry.lock
generated
Normal file
File diff suppressed because it is too large
Load diff
|
|
@ -7,6 +7,9 @@ BASE_PATTERN = r'({variable} = ").+(")'
|
|||
PACKAGE_VERSION = re.compile(BASE_PATTERN.format(variable="__version__"))
|
||||
API_VERSION = re.compile(BASE_PATTERN.format(variable="__api_version__"))
|
||||
API_VERSION_BADGE = re.compile(r"(API-)[\d.]+(-blue\.svg)")
|
||||
API_VERSION_LINE = re.compile(
|
||||
r"(Supports `Telegram Bot API )[\d.]+( <https://core\.telegram\.org/bots/api>`_ )"
|
||||
)
|
||||
|
||||
STAGE_MAPPING = {
|
||||
"alpha": "a",
|
||||
|
|
@ -54,9 +57,10 @@ def write_package_meta(package_version: str, api_version: str) -> None:
|
|||
|
||||
|
||||
def write_readme(package_version: str, api_version: str) -> None:
|
||||
path = Path.cwd() / "README.md"
|
||||
path = Path.cwd() / "README.rst"
|
||||
content = path.read_text()
|
||||
content = replace_line(content, API_VERSION_BADGE, api_version)
|
||||
content = replace_line(content, API_VERSION_LINE, api_version)
|
||||
print(f"Write {path}")
|
||||
path.write_text(content)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue