aiogram/docs/source/index.rst

78 lines
2.3 KiB
ReStructuredText
Raw Normal View History

2017-06-03 11:58:26 +03:00
Welcome to aiogram's documentation!
===================================
.. 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/pyversions/aiogram.svg
:target: https://pypi.python.org/pypi/aiogram
:alt: Supported python versions
.. image:: https://readthedocs.org/projects/aiogram/badge/?version=latest
:target: http://aiogram.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/bitbucket/issues/illemius/aiogram.svg
:target: https://bitbucket.org/illemius/aiogram/issues
:alt: Bitbucket issues
.. image:: https://img.shields.io/pypi/l/aiogram.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT License
2017-07-29 05:37:13 +03:00
**aiogram** is are pretty simple and fully asynchronously library for `Telegram Bot API <https://core.telegram.org/bots/api>`_ written in Python 3.6 with `asyncio <https://docs.python.org/3/library/asyncio.html>`_ and `aiohttp <https://github.com/aio-libs/aiohttp>`_. It helps to make your bots more faster and simpler.
Official aiogram resources
--------------------------
- News: `@aiogram_live <https://t.me/aiogram_live>`_
- Community: `@aiogram <https://t.me/aiogram>`_
- Russian community: `@aiogram_ru <https://t.me/aiogram_ru>`_
- Pip: `aiogram <https://pypi.python.org/pypi/aiogram>`_
- Docs: `ReadTheDocs <http://aiogram.readthedocs.io>`_
- Source: `Bitbucket repo <https://bitbucket.org/illemius/aiogram>`_
- Issues/Bug tracker: `Bitbucket issues tracker <https://bitbucket.org/illemius/aiogram/issues>`_
- Test bot: `@aiogram_bot <https://t.me/aiogram_bot>`_
2017-06-03 12:12:56 +03:00
Features
--------
- Asynchronous
- Be awesome
- Make things faster
2017-07-29 05:37:13 +03:00
- Have `FSM <https://en.wikipedia.org/wiki/Finite-state_machine>`_
2017-06-03 12:12:56 +03:00
Contribute
----------
- `Issue Tracker <https://bitbucket.org/illemius/aiogram/issues>`_
- `Source Code <https://bitbucket.org/illemius/aiogram.git>`_
2017-06-03 11:58:26 +03:00
Contents
--------
.. toctree::
install
quick_start
2017-08-14 23:23:10 +03:00
bot
dispatcher
types
features
2017-06-03 11:58:26 +03:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`