venv.rst 7.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

.. _tut-venv:

*********************************
Virtual Environments and Packages
*********************************

Introduction
============

Python applications will often use packages and modules that don't
come as part of the standard library.  Applications will sometimes
need a specific version of a library, because the application may
require that a particular bug has been fixed or the application may be
written using an obsolete version of the library's interface.

This means it may not be possible for one Python installation to meet
the requirements of every application.  If application A needs version
1.0 of a particular module but application B needs version 2.0, then
the requirements are in conflict and installing either version 1.0 or 2.0
will leave one application unable to run.

23 24 25
The solution for this problem is to create a :term:`virtual environment`, a
self-contained directory tree that contains a Python installation for a
particular version of Python, plus a number of additional packages.
26 27 28 29

Different applications can then use different virtual environments.
To resolve the earlier example of conflicting requirements,
application A can have its own virtual environment with version 1.0
30
installed while application B has another virtual environment with version 2.0.
31 32 33 34 35 36 37
If application B requires a library be upgraded to version 3.0, this will
not affect application A's environment.


Creating Virtual Environments
=============================

38 39 40 41 42
The module used to create and manage virtual environments is called
:mod:`venv`.  :mod:`venv` will usually install the most recent version of
Python that you have available. If you have multiple versions of Python on your
system, you can select a specific Python version by running ``python3`` or
whichever version you want.
43

44 45
To create a virtual environment, decide upon a directory where you want to
place it, and run the :mod:`venv` module as a script with the directory path::
46

47
   python3 -m venv tutorial-env
48 49 50

This will create the ``tutorial-env`` directory if it doesn't exist,
and also create directories inside it containing a copy of the Python
51
interpreter, the standard library, and various supporting files.
52

53
Once you've created a virtual environment, you may activate it.
54 55 56

On Windows, run::

57
  tutorial-env\Scripts\activate.bat
58 59 60 61 62 63 64 65 66 67

On Unix or MacOS, run::

  source tutorial-env/bin/activate

(This script is written for the bash shell.  If you use the
:program:`csh` or :program:`fish` shells, there are alternate
``activate.csh`` and ``activate.fish`` scripts you should use
instead.)

68 69 70 71
Activating the virtual environment will change your shell's prompt to show what
virtual environment you're using, and modify the environment so that running
``python`` will get you that particular version and installation of Python.
For example:
72

73 74 75 76 77
.. code-block:: bash

  $ source ~/envs/tutorial-env/bin/activate
  (tutorial-env) $ python
  Python 3.5.1 (default, May  6 2016, 10:59:36)
78 79 80
    ...
  >>> import sys
  >>> sys.path
81 82
  ['', '/usr/local/lib/python35.zip', ...,
  '~/envs/tutorial-env/lib/python3.5/site-packages']
83 84 85 86 87 88
  >>>


Managing Packages with pip
==========================

89 90
You can install, upgrade, and remove packages using a program called
:program:`pip`.  By default ``pip`` will install packages from the Python
91
Package Index, <https://pypi.org>.  You can browse the Python
92 93 94 95
Package Index by going to it in your web browser, or you can use ``pip``'s
limited search feature:

.. code-block:: bash
96

97
  (tutorial-env) $ pip search astronomy
98 99 100 101 102 103 104 105 106 107 108
  skyfield               - Elegant astronomy for Python
  gary                   - Galactic astronomy and gravitational dynamics.
  novas                  - The United States Naval Observatory NOVAS astronomy library
  astroobs               - Provides astronomy ephemeris to plan telescope observations
  PyAstronomy            - A collection of astronomy related tools for Python.
  ...

``pip`` has a number of subcommands: "search", "install", "uninstall",
"freeze", etc.  (Consult the :ref:`installing-index` guide for
complete documentation for ``pip``.)

109 110 111
You can install the latest version of a package by specifying a package's name:

.. code-block:: bash
112

113
  (tutorial-env) $ pip install novas
114 115 116 117 118 119 120
  Collecting novas
    Downloading novas-3.1.1.3.tar.gz (136kB)
  Installing collected packages: novas
    Running setup.py install for novas
  Successfully installed novas-3.1.1.3

You can also install a specific version of a package by giving the
121
package name  followed by ``==`` and the version number:
122

123 124 125
.. code-block:: bash

  (tutorial-env) $ pip install requests==2.6.0
126 127 128 129 130 131 132 133
  Collecting requests==2.6.0
    Using cached requests-2.6.0-py2.py3-none-any.whl
  Installing collected packages: requests
  Successfully installed requests-2.6.0

If you re-run this command, ``pip`` will notice that the requested
version is already installed and do nothing.  You can supply a
different version number to get that version, or you can run ``pip
134 135 136
install --upgrade`` to upgrade the package to the latest version:

.. code-block:: bash
137

138
  (tutorial-env) $ pip install --upgrade requests
139 140 141 142 143 144 145 146 147 148
  Collecting requests
  Installing collected packages: requests
    Found existing installation: requests 2.6.0
      Uninstalling requests-2.6.0:
        Successfully uninstalled requests-2.6.0
  Successfully installed requests-2.7.0

``pip uninstall`` followed by one or more package names will remove the
packages from the virtual environment.

149
``pip show`` will display information about a particular package:
150

151 152 153
.. code-block:: bash

  (tutorial-env) $ pip show requests
154 155 156 157 158 159 160 161 162 163 164 165 166
  ---
  Metadata-Version: 2.0
  Name: requests
  Version: 2.7.0
  Summary: Python HTTP for Humans.
  Home-page: http://python-requests.org
  Author: Kenneth Reitz
  Author-email: me@kennethreitz.com
  License: Apache 2.0
  Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
  Requires:

``pip list`` will display all of the packages installed in the virtual
167 168 169
environment:

.. code-block:: bash
170

171
  (tutorial-env) $ pip list
172 173 174 175 176 177 178 179
  novas (3.1.1.3)
  numpy (1.9.2)
  pip (7.0.3)
  requests (2.7.0)
  setuptools (16.0)

``pip freeze`` will produce a similar list of the installed packages,
but the output uses the format that ``pip install`` expects.
180
A common convention is to put this list in a ``requirements.txt`` file:
181

182 183 184 185
.. code-block:: bash

  (tutorial-env) $ pip freeze > requirements.txt
  (tutorial-env) $ cat requirements.txt
186 187 188 189 190 191
  novas==3.1.1.3
  numpy==1.9.2
  requests==2.7.0

The ``requirements.txt`` can then be committed to version control and
shipped as part of an application.  Users can then install all the
192 193 194
necessary packages with ``install -r``:

.. code-block:: bash
195

196
  (tutorial-env) $ pip install -r requirements.txt
197 198 199 200 201 202 203 204 205 206 207 208
  Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
    ...
  Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
    ...
  Collecting requests==2.7.0 (from -r requirements.txt (line 3))
    ...
  Installing collected packages: novas, numpy, requests
    Running setup.py install for novas
  Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0

``pip`` has many more options.  Consult the :ref:`installing-index`
guide for complete documentation for ``pip``.  When you've written
209
a package and want to make it available on the Python Package Index,
210
consult the :ref:`distributing-index` guide.