mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-09-01 14:55:12 +00:00
Code Issues Releases Wiki Activity

Revert "Add Fast Crypto (TgCrypto) docs"

Browse Source 
This reverts commit cf213e6
This commit is contained in:
Dan
2018-02-08 16:48:16 +01:00
parent 077eb386de
commit 7a904d8fff
2 changed files with 0 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/index.rst
View File

@@ -63,9 +63,6 @@ Features
`MTProto Mobile Protocol v2.0`_ and the mechanisms needed for establishing `MTProto Mobile Protocol v2.0`_ and the mechanisms needed for establishing
a reliable connection. a reliable connection.
- **Fast**: Pyrogram's speed is boosted up by `TgCrypto`_, a high-performance, easy-to-install
crypto library written in C.
- **Updated**: Pyrogram makes use of the latest Telegram API version, currently `Layer 75`_. - **Updated**: Pyrogram makes use of the latest Telegram API version, currently `Layer 75`_.
- **Documented**: Pyrogram API public methods are documented and resemble the well - **Documented**: Pyrogram API public methods are documented and resemble the well
@@ -108,7 +105,6 @@ To get started, press Next.
resources/ErrorHandling resources/ErrorHandling
resources/ProxyServer resources/ProxyServer
resources/AutoAuthorization resources/AutoAuthorization
resources/FastCrypto
.. toctree:: .. toctree::
:hidden: :hidden:
@@ -125,6 +121,4 @@ To get started, press Next.
.. _`MTProto Mobile Protocol v2.0`: https://core.telegram.org/mtproto .. _`MTProto Mobile Protocol v2.0`: https://core.telegram.org/mtproto
.. _TgCrypto: https://docs.pyrogram.ml/resources/FastCrypto/
.. _`Layer 75`: https://github.com/pyrogram/pyrogram/blob/master/compiler/api/source/main_api.tl .. _`Layer 75`: https://github.com/pyrogram/pyrogram/blob/master/compiler/api/source/main_api.tl

37
docs/source/resources/FastCrypto.rst
View File

@@ -1,37 +0,0 @@
Fast Crypto
===========
Pyrogram's speed can be *dramatically* boosted up by installing TgCrypto_, a high-performance, easy-to-install crypto
library specifically written in C for Pyrogram [#f1]_. TgCrypto is a replacement for the painfully slow PyAES and
implements the crypto algorithms MTProto requires, namely AES-IGE and AES-CTR 256 bit.
Installation
------------
.. code-block:: bash
$ pip install --upgrade tgcrypto
.. note:: Being a C extension for Python, TgCrypto is an optional but *highly recommended* dependency; when TgCrypto
is not detected on your system, Pyrogram will automatically fall back to PyAES and will show you a warning.
The reason about being an optional package is that TgCrypto requires some extra system tools in order to be compiled.
Usually the errors you receive when trying to install TgCrypto are enough to understand what you should do next.
- **Windows**: Install `Visual C++ 2015 Build Tools <http://landinghub.visualstudio.com/visual-cpp-build-tools>`_.
- **macOS**: A pop-up will automatically ask you to install the command line developer tools as soon as you issue the
installation command.
- **Linux**: Depending on your distro, install a proper C compiler (``gcc``, ``clang``) and the Python header files
(``python3-dev``).
- **Termux (Android)**: Install ``clang`` and ``python-dev`` packages.
More help on the `Pyrogram group chat <https://t.me/PyrogramChat>`_.
.. _TgCrypto: https://github.com/pyrogram/tgcrypto
.. [#f1] Although TgCrypto is intended for Pyrogram, it is shipped as a standalone package and can thus be used for
other projects too.