mirror of
https://github.com/kennethreitz/python-guide.git
synced 2026-06-05 14:50:19 +00:00
Mr-Io
20f0c9c2b7
Replace %HOME% with %USERPROFILE% when referencing commands line in windows. This is already done in other part of the guide such as in virtualenvwrapper.
138 lines
4.9 KiB
ReStructuredText
138 lines
4.9 KiB
ReStructuredText
.. _pip-virtualenv:
|
|
|
|
Further Configuration of pip and Virtualenv
|
|
===========================================
|
|
|
|
.. image:: /_static/photos/34018732105_f0e6758859_k_d.jpg
|
|
|
|
Requiring an active virtual environment for ``pip``
|
|
---------------------------------------------------
|
|
|
|
By now it should be clear that using virtual environments is a great way to
|
|
keep your development environment clean and keeping different projects'
|
|
requirements separate.
|
|
|
|
When you start working on many different projects, it can be hard to remember to
|
|
activate the related virtual environment when you come back to a specific
|
|
project. As a result of this, it is very easy to install packages globally
|
|
while thinking that you are actually installing the package for the virtual
|
|
environment of the project. Over time this can result in a messy global package
|
|
list.
|
|
|
|
In order to make sure that you install packages to your active virtual
|
|
environment when you use ``pip install``, consider adding the following
|
|
line to your :file:`~/.bashrc` file:
|
|
|
|
.. code-block:: console
|
|
|
|
export PIP_REQUIRE_VIRTUALENV=true
|
|
|
|
After saving this change and sourcing the :file:`~/.bashrc` file with
|
|
``source ~/.bashrc``, pip will no longer let you install packages if you are not
|
|
in a virtual environment. If you try to use ``pip install`` outside of a
|
|
virtual environment pip will gently remind you that an activated virtual
|
|
environment is needed to install packages.
|
|
|
|
.. code-block:: console
|
|
|
|
$ pip install requests
|
|
Could not find an activated virtualenv (required).
|
|
|
|
You can also do this configuration by editing your :file:`pip.conf` or
|
|
:file:`pip.ini` file. :file:`pip.conf` is used by Unix and Mac OS X operating
|
|
systems and it can be found at:
|
|
|
|
.. code-block:: console
|
|
|
|
$HOME/.pip/pip.conf
|
|
|
|
Similarly, the :file:`pip.ini` file is used by Windows operating systems and it
|
|
can be found at:
|
|
|
|
.. code-block:: console
|
|
|
|
%USERPROFILE%\pip\pip.ini
|
|
|
|
If you don't have a :file:`pip.conf` or :file:`pip.ini` file at these locations,
|
|
you can create a new file with the correct name for your operating system.
|
|
|
|
If you already have a configuration file, just add the following line under the
|
|
``[global]`` settings to require an active virtual environment:
|
|
|
|
.. code-block:: console
|
|
|
|
require-virtualenv = true
|
|
|
|
If you did not have a configuration file, you will need to create a new one and
|
|
add the following lines to this new file:
|
|
|
|
.. code-block:: console
|
|
|
|
[global]
|
|
require-virtualenv = true
|
|
|
|
|
|
You will of course need to install some packages globally (usually ones that
|
|
you use across different projects consistently) and this can be accomplished by
|
|
adding the following to your :file:`~/.bashrc` file:
|
|
|
|
.. code-block:: console
|
|
|
|
gpip() {
|
|
PIP_REQUIRE_VIRTUALENV="" pip "$@"
|
|
}
|
|
|
|
After saving the changes and sourcing your :file:`~/.bashrc` file you can now
|
|
install packages globally by running ``gpip install``. You can change the name
|
|
of the function to anything you like, just keep in mind that you will have to
|
|
use that name when trying to install packages globally with pip.
|
|
|
|
Caching packages for future use
|
|
-------------------------------
|
|
|
|
Every developer has preferred libraries and when you are working on a lot of
|
|
different projects, you are bound to have some overlap between the libraries
|
|
that you use. For example, you may be using the ``requests`` library in a lot
|
|
of different projects.
|
|
|
|
It is surely unnecessary to re-download the same packages/libraries each time
|
|
you start working on a new project (and in a new virtual environment as a
|
|
result). Fortunately, starting with version 6.0, pip provides an `on-by-default
|
|
caching mechanism
|
|
<https://pip.pypa.io/en/stable/reference/pip_install/#caching>`_ that doesn't
|
|
need any configuration.
|
|
|
|
When using older versions, you can configure pip in such a way that it tries to
|
|
reuse already installed packages, too.
|
|
|
|
On Unix systems, you can add the following line to your :file:`.bashrc` or
|
|
:file:`.bash_profile` file.
|
|
|
|
.. code-block:: console
|
|
|
|
export PIP_DOWNLOAD_CACHE=$HOME/.pip/cache
|
|
|
|
You can set the path to anywhere you like (as long as you have write
|
|
access). After adding this line, ``source`` your :file:`.bashrc`
|
|
(or :file:`.bash_profile`) file and you will be all set.
|
|
|
|
Another way of doing the same configuration is via the :file:`pip.conf` or
|
|
:file:`pip.ini` files, depending on your system. If you are on Windows, you can
|
|
add the following line to your :file:`pip.ini` file under ``[global]`` settings:
|
|
|
|
.. code-block:: console
|
|
|
|
download-cache = %USERPROFILE%\pip\cache
|
|
|
|
Similarly, on Unix systems you should simply add the following line to your
|
|
:file:`pip.conf` file under ``[global]`` settings:
|
|
|
|
.. code-block:: console
|
|
|
|
download-cache = $HOME/.pip/cache
|
|
|
|
Even though you can use any path you like to store your cache, it is recommended
|
|
that you create a new folder *in* the folder where your :file:`pip.conf` or
|
|
:file:`pip.ini` file lives. If you don't trust yourself with all of this path
|
|
voodoo, just use the values provided here and you will be fine.
|