From 2f9fc823da8868b4c4aa152147eb80fc6abeb628 Mon Sep 17 00:00:00 2001 From: Can Ibanoglu Date: Sat, 15 Mar 2014 11:48:55 +0200 Subject: [PATCH] Deleted the horizontal line, took back the messed up commits --- docs/starting/pip-virtualenv.rst | 44 +++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/docs/starting/pip-virtualenv.rst b/docs/starting/pip-virtualenv.rst index 56e33cc..c766235 100644 --- a/docs/starting/pip-virtualenv.rst +++ b/docs/starting/pip-virtualenv.rst @@ -1,7 +1,10 @@ .. _pip-virtualenv: Further Configuration of Pip and Virtualenv -------------------------------------------- +=========================================== + +Requiring an active virtual environment for ``pip`` +--------------------------------------------------- By now it should be clear that using virtual envirtonments is a great way to keep your development environment clean and keeping different projects' requirements @@ -18,6 +21,7 @@ when you use ``pip install``, consider adding the following two lines to your ``~/.bashrc`` file: .. code-block:: console + export PIP_REQUIRE_VIRTUALENV=true After saving this change and sourcing the ``~/.bashrc`` file with ``source ~/.bashrc``, @@ -26,14 +30,50 @@ If you try to use ``pip install`` outside of a virtual environment pip will gent 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 ``pip.conf`` or ``pip.ini`` +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 ``pip.ini`` file is used by Windows operating systems and it can +be found at: + +.. code-block:: console + + %HOME%\pip\pip.ini + +If you don't have a ``pip.conf`` or ``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 consistenly) and this can be accomplished by adding the following to your ``~/.bashrc`` file: .. code-block:: console + gpip() { PIP_REQUIRE_VIRTUALENV="" pip "$@" } @@ -42,5 +82,3 @@ After saving the changes and sourcing your ``~/.bashrc`` file you can now instal 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. - ------------------------------------------------------------