From 100a4cb4228af1b7268f45906bdea0fe398e45b5 Mon Sep 17 00:00:00 2001 From: Can Ibanoglu Date: Thu, 6 Mar 2014 16:56:22 +0200 Subject: [PATCH] Created a new section for virtualenv and pip --- docs/starting/install/osx.rst | 44 ------------------------------ docs/starting/pip-virtualenv.rst | 46 ++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 44 deletions(-) create mode 100644 docs/starting/pip-virtualenv.rst diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst index b84eeb0..0489636 100644 --- a/docs/starting/install/osx.rst +++ b/docs/starting/install/osx.rst @@ -118,50 +118,6 @@ copy your code out of it, and then delete the main directory for the environment An useful set of extensions to virtualenv is available in virtualenvwrapper, `RTFD `_ to find out more. - -A note about Pip and Virtualenv -------------------------------- - -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 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``, -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 will of course need to install some packages globally and this can be accomplished -by adding the following to your ``~/.bashrc`` file: - -.. code-block:: console - gpip() { - PIP_REQUIRE_VIRTUALENV="" pip "$@" - } - -After saving the changes and sourcing your ``~/.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 install packages globally with pip. - -------------------------------- This page is a remixed version of `another guide `_, diff --git a/docs/starting/pip-virtualenv.rst b/docs/starting/pip-virtualenv.rst new file mode 100644 index 0000000..56e33cc --- /dev/null +++ b/docs/starting/pip-virtualenv.rst @@ -0,0 +1,46 @@ +.. _pip-virtualenv: + +Further Configuration of Pip and Virtualenv +------------------------------------------- + +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 +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 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``, +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 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 "$@" + } + +After saving the changes and sourcing your ``~/.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. + +-----------------------------------------------------------