mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
1349554dfd
* Update installation instruction for Arch The package is now available in the official repository. * Add pacman command example * Add an additional empty line
101 lines
2.6 KiB
ReStructuredText
101 lines
2.6 KiB
ReStructuredText
Installation Guide
|
|
==================
|
|
|
|
Using PIP
|
|
---------
|
|
.. code-block:: bash
|
|
|
|
$ pip install -U aiogram
|
|
|
|
Using Pipenv
|
|
------------
|
|
.. code-block:: bash
|
|
|
|
$ pipenv install aiogram
|
|
|
|
Using Pacman
|
|
---------
|
|
*aiogram* is also available in Arch Linux Repository, so you can install this framework on any Arch-based distribution like Arch Linux, Antergos, Manjaro, etc. To do this, just use pacman to install the `python-aiogram <https://archlinux.org/packages/community/any/python-aiogram/>`_ package:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pacman -S python-aiogram
|
|
|
|
From sources
|
|
------------
|
|
|
|
Development versions:
|
|
|
|
.. code-block:: bash
|
|
|
|
$ git clone https://github.com/aiogram/aiogram.git
|
|
$ cd aiogram
|
|
$ python setup.py install
|
|
|
|
Or if you want to install stable version (The same with version form PyPi):
|
|
|
|
.. code-block:: bash
|
|
|
|
$ git clone https://github.com/aiogram/aiogram.git
|
|
$ cd aiogram
|
|
$ git checkout master
|
|
$ python setup.py install
|
|
|
|
|
|
Recommendations
|
|
---------------
|
|
You can speedup your bots by following next instructions:
|
|
|
|
- Use `uvloop <https://github.com/MagicStack/uvloop>`_ instead of default asyncio loop.
|
|
|
|
*uvloop* is a fast, drop-in replacement of the built-in asyncio event loop. uvloop is implemented in Cython and uses libuv under the hood.
|
|
|
|
**Installation:**
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install uvloop
|
|
|
|
- Use `ujson <https://github.com/esnme/ultrajson>`_ instead of the default json module.
|
|
|
|
*UltraJSON* is an ultra fast JSON encoder and decoder written in pure C with bindings for Python 2.5+ and 3.
|
|
|
|
**Installation:**
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install ujson
|
|
|
|
- Use aiohttp speedups
|
|
|
|
- Use `cchardet <https://github.com/PyYoshi/cChardet>`_ instead of the chardet module.
|
|
|
|
*cChardet* is a high speed universal character encoding detector.
|
|
|
|
**Installation:**
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install cchardet
|
|
|
|
- Use `aiodns <https://github.com/saghul/aiodns>`_ for speeding up DNS resolving.
|
|
|
|
*aiodns* provides a simple way for doing asynchronous DNS resolutions.
|
|
|
|
**Installation:**
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install aiodns
|
|
|
|
- Installing speedups altogether.
|
|
|
|
The following will get you ``aiohttp`` along with ``cchardet``, ``aiodns`` and ``brotlipy`` in one bundle.
|
|
|
|
**Installation:**
|
|
|
|
.. code-block:: bash
|
|
|
|
$ pip install aiohttp[speedups]
|
|
|
|
In addition, you don't need do anything, *aiogram* automatically starts using that if it is found in your environment.
|