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.
Note
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.
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 Packaging 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.
See also
Python Packaging User Guide: Creating and using virtual environments
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 Packaging Index:
Note
For POSIX users (including Mac OS X 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.
See also
Python Packaging User Guide: Installing Python Distribution Packages
These are quick answers or links for some common tasks.
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.
See also
Python Packaging User Guide: Requirements for Installing Packages
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.
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.
See also
Python Packaging User Guide: Installing Scientific Packages
On Linux, Mac OS X, 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:
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.
It is possible that pip does not get installed by default. One potential fix is:
There are also additional resources for installing pip.
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 Mac OS X through the Python Packaging 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.
------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------
Python is the second programming language we will use in this course.
Note: We do not install the python using the installer from the python.org website in this course. If you have one installed you should uninstall it before installing this version of python.
Currently the curriculum for this course is compatible with Python 3.9.
The first thing we need is to install the Python version manager (pyenv). This is similar to the nvm tool we used to install Node.JS, except it controls what versions of python we use on our system.
To install pyenv we use the pyenv-installer
From the installation instructions on the pyenv-installer website, it says we run the following command:
Unlike nvm, pyenv does not automatically add it's startup lines to your shell startup file.
The files that you have to change will depend on which shell you are running (you can check which shell you have by running echo $SHELL). Follow the instructions to update the startup files associated with the shell that you are running.
zshOpen up your .profile file with the following command.
Add the following lines to your .profile.
Open up your .zprofile file with the following command.
Add the following lines to your .zprofile. (Yes, these are the same as above.)
Open your .zshrc with the following command
Add the following line.
bashOpen up your .profile file with the following command.
Add the following lines.
Check if you have a .bash_profile. Run the following at the command line if you don't know.
If you don't have a .bash_profile, you can skip the rest of this step. If you do, open up your .bash_profile file with the following command.
Add the following lines to your .bash_profile. (Yes, these are the same as above.)
Open your .bashrc with the following command
Add the following line.
To get your startup file to execute, restart your terminal.
If you use macOS you can skip this step.
For Windows and Ubuntu users you will need to install some extra dependencies for python. (See here for more information about the prerequisites: pyenv Prerequities)
First run this command to update your apt repositories:
and then run this command to install the packages listed on the pyenv.
Now we are ready to install python. We will be installing Python version 3.9.4.
Then run this command to install python (you'll notice pyenv makes us put in the exact version instead of being able to just say 3.9 or 3)
After some time this should complete without any errors. It could take a while since you are compiling python from source code.
Once this is finished we also need to tell pyenv this is our default version of python using this command:
Ensure that these changes take effect by closing your terminal and opening a new one. Then, we can verify our python is the correct version by typing
Both of these commands should show 3.9.4
Another piece of software we will use in class is Pipenv. Don't worry about what this is right now, it's just enough to install it.
Then after you have installed pipenv, add this line to your shell startup file (either your .bashrc or your .zshrc) somewhere after the eval "$(pyenv init -)".
Congratulations! If you've completed all these steps you are ready to code in Python!