mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-16 20:59:29 +00:00
63 lines
1.7 KiB
ReStructuredText
63 lines
1.7 KiB
ReStructuredText
Install Guide
|
|
=============
|
|
|
|
Being a modern Python library, **Pyrogram** requires Python 3.6+ to be installed in your system.
|
|
We recommend using the latest versions of both Python 3 and pip.
|
|
|
|
- Get **Python 3** from https://www.python.org/downloads/ (or with your package manager).
|
|
- Get **pip** by following the instructions at https://pip.pypa.io/en/latest/installing/.
|
|
|
|
.. important::
|
|
|
|
Pyrogram supports **Python 3** only, starting from version 3.6. **PyPy** is supported too.
|
|
|
|
.. contents:: Contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
-----
|
|
|
|
Install Pyrogram
|
|
----------------
|
|
|
|
- The easiest way to install and upgrade Pyrogram to its latest stable version is by using **pip**:
|
|
|
|
.. code-block:: text
|
|
|
|
$ pip3 install -U pyrogram
|
|
|
|
- or, with :doc:`TgCrypto <../topics/tgcrypto>` as extra requirement (recommended):
|
|
|
|
.. code-block:: text
|
|
|
|
$ pip3 install -U pyrogram tgcrypto
|
|
|
|
Bleeding Edge
|
|
-------------
|
|
|
|
Pyrogram is always evolving, although new releases on PyPI are published only when enough changes are added, but this
|
|
doesn't mean you can't try new features right now!
|
|
|
|
In case you'd like to try out the latest Pyrogram features, the `GitHub repo`_ is always kept updated with new changes;
|
|
you can install the development version straight from the ``master`` branch using this command (note "master.zip" in
|
|
the link):
|
|
|
|
.. code-block:: text
|
|
|
|
$ pip3 install -U https://github.com/pyrogram/pyrogram/archive/master.zip
|
|
|
|
Verifying
|
|
---------
|
|
|
|
To verify that Pyrogram is correctly installed, open a Python shell and import it.
|
|
If no error shows up you are good to go.
|
|
|
|
.. parsed-literal::
|
|
|
|
>>> import pyrogram
|
|
>>> pyrogram.__version__
|
|
'|version|'
|
|
|
|
.. _`Github repo`: http://github.com/pyrogram/pyrogram
|