Installing Python Modules¶
As a popular open source development project, Python has an active supporting community of contributors and users that also make their software available for other Python developers to use under open source license terms.
This allows Python users to share and collaborate effectively, benefiting from the solutions others have already created to common (and sometimes even rare!) problems, as well as potentially contributing their own solutions to the common pool.
This guide covers the installation part of the process. For a guide to creating and sharing your own Python projects, refer to the distribution guide .
For corporate and other institutional users, be aware that many organisations have their own policies around using and contributing to open source software. Please take such policies into account when making use of the distribution and installation tools provided with Python.
Key terms¶
pip is the preferred installer program. Starting with Python 3.4, it is included by default with the Python binary installers.
A virtual environment is a semi-isolated Python environment that allows packages to be installed for use by a particular application, rather than being installed system wide.
venv is the standard tool for creating virtual environments, and has been part of Python since Python 3.3. Starting with Python 3.4, it defaults to installing pip into all created virtual environments.
virtualenv is a third party alternative (and predecessor) to venv . It allows virtual environments to be used on versions of Python prior to 3.4, which either don’t provide venv at all, or aren’t able to automatically install pip into created environments.
The Python Package Index is a public repository of open source licensed packages made available for use by other Python users.
the Python Packaging Authority is the group of developers and documentation authors responsible for the maintenance and evolution of the standard packaging tools and the associated metadata and file format standards. They maintain a variety of tools, documentation, and issue trackers on both GitHub and Bitbucket.
distutils is the original build and distribution system first added to the Python standard library in 1998. While direct use of distutils is being phased out, it still laid the foundation for the current packaging and distribution infrastructure, and it not only remains part of the standard library, but its name lives on in other ways (such as the name of the mailing list used to coordinate Python packaging standards development).
Changed in version 3.5: The use of venv is now recommended for creating virtual environments.
Basic usage¶
The standard packaging tools are all designed to be used from the command line.
The following command will install the latest version of a module and its dependencies from the Python Package Index:
For POSIX users (including macOS and Linux users), the examples in this guide assume the use of a virtual environment .
For Windows users, the examples in this guide assume that the option to adjust the system PATH environment variable was selected when installing Python.
It’s also possible to specify an exact or minimum version directly on the command line. When using comparator operators such as > , < or some other special character which get interpreted by shell, the package name and the version should be enclosed within double quotes:
Normally, if a suitable module is already installed, attempting to install it again will have no effect. Upgrading existing modules must be requested explicitly:
More information and resources regarding pip and its capabilities can be found in the Python Packaging User Guide.
Creation of virtual environments is done through the venv module. Installing packages into an active virtual environment uses the commands shown above.
How do I …?¶
These are quick answers or links for some common tasks.
… install pip in versions of Python prior to Python 3.4?¶
Python only started bundling pip with Python 3.4. For earlier versions, pip needs to be “bootstrapped” as described in the Python Packaging User Guide.
… install packages just for the current user?¶
Passing the —user option to python -m pip install will install a package just for the current user, rather than for all users of the system.
… install scientific Python packages?¶
A number of scientific Python packages have complex binary dependencies, and aren’t currently easy to install using pip directly. At this point in time, it will often be easier for users to install these packages by other means rather than attempting to install them with pip .
… work with multiple versions of Python installed in parallel?¶
On Linux, macOS, and other POSIX systems, use the versioned Python commands in combination with the -m switch to run the appropriate copy of pip :
Appropriately versioned pip commands may also be available.
On Windows, use the py Python launcher in combination with the -m switch:
Common installation issues¶
Installing into the system Python on Linux¶
On Linux systems, a Python installation will typically be included as part of the distribution. Installing into this Python installation requires root access to the system, and may interfere with the operation of the system package manager and other components of the system if a component is unexpectedly upgraded using pip .
On such systems, it is often better to use a virtual environment or a per-user installation when installing packages with pip .
Pip not installed¶
It is possible that pip does not get installed by default. One potential fix is:
There are also additional resources for installing pip.
Installing binary extensions¶
Python has typically relied heavily on source based distribution, with end users being expected to compile extension modules from source as part of the installation process.
With the introduction of support for the binary wheel format, and the ability to publish wheels for at least Windows and macOS through the Python Package Index, this problem is expected to diminish over time, as users are more regularly able to install pre-built extensions rather than needing to build them themselves.
Some of the solutions for installing scientific software that are not yet available as pre-built wheel files may also help with obtaining other binary extensions without needing to build them locally.
Installation¶
Being a Python library, Pyrogram requires Python to be installed in your system. We recommend using the latest version of 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/.
Pyrogram supports Python 3 only, starting from version 3.4. PyPy is supported too.
Install Pyrogram¶
The easiest way to install and upgrade Pyrogram to its latest stable version is by using pip:
or, with TgCrypto as extra requirement (recommended):
Bleeding Edge¶
Things are constantly evolving in Pyrogram, although new releases are published only when enough changes are added, but this doesn’t mean you can’t try new features right now!
In case you would like to try out the latest Pyrogram features and additions, the GitHub repo is always kept updated with new changes; you can install the development version straight from the develop branch using this command (note “develop.zip” in the link):
Asynchronous¶
Pyrogram heavily depends on IO-bound network code (it’s a cloud-based messaging framework after all), and here’s where asyncio shines the most by providing extra performance while running on a single OS-level thread only.
A fully asynchronous variant of Pyrogram is therefore available (Python 3.5.3+ required). Use this command to install (note “asyncio.zip” in the link):
Pyrogram API remains the same and features are kept up to date from the non-async, default develop branch, but you are obviously required Python asyncio knowledge in order to take full advantage of it.
The idea to turn Pyrogram fully asynchronous is still under consideration, but is wise to expect that in future this would be the one and only way to work with Pyrogram.
You can start using Pyrogram Async variant right now as an excuse to learn more about asynchronous programming and do experiments with it!
Subscribe to @Pyrogram for news and announcements
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.
Install Guide#
Being a modern Python framework, Pyrogram requires an up to date version of Python to be installed in your system. We recommend using the latest versions of both Python 3 and pip.
Install Pyrogram#
The easiest way to install and upgrade Pyrogram to its latest stable version is by using pip:
or, with TgCrypto as extra requirement (recommended):
Bleeding Edge#
You can install the development version from the git master branch using this command:
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.
Name already in use
Work fast with our official CLI. Learn more about the CLI.
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
Telegram MTProto API Framework for Python
Documentation • Releases • Community
Pyrogram is an elegant, easy-to-use Telegram client library and framework written from the ground up in Python and C. It enables you to easily create custom apps for both user and bot identities (bot API alternative) via the MTProto API.
- Easy: You can install Pyrogram with pip and start building your applications right away.
- Elegant: Low-level details are abstracted and re-presented in a much nicer and easier way.
- Fast: Crypto parts are boosted up by TgCrypto, a high-performance library written in pure C.
- Documented: Pyrogram API methods, types and public interfaces are well documented.
- Type-hinted: Exposed Pyrogram types and method parameters are all type-hinted.
- Updated, to make use of the latest Telegram API version and features.
- Bot API-like: Similar to the Bot API in its simplicity, but much more powerful and detailed.
- Pluggable: The Smart Plugin system allows to write components with minimal boilerplate code.
- Comprehensive: Execute any advanced action an official client is able to do, and even more.
- Python 3.5.3 or higher.
- A Telegram API key.
- The Docs contain lots of resources to help you getting started with Pyrogram: https://docs.pyrogram.org.
- Reading Examples in this repository is also a good way for learning how Pyrogram works.
- Seeking extra help? Don’t be shy, come join and ask our Community!
- For other requests you can send an Email or a Message.
Pyrogram is brand new, and you are welcome to try it and help make it even better by either submitting pull requests or reporting issues/bugs as well as suggesting best practices, ideas, enhancements on both code and documentation. Any help is appreciated!