Mark up files & directories

This commit is contained in:
Zearin
2014-04-11 11:26:37 -04:00
parent a604dd1095
commit cc7b19356e
13 changed files with 69 additions and 68 deletions
+14 -14
View File
@@ -18,13 +18,13 @@ 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:
:file:`~/.bashrc` file:
.. code-block:: console
export PIP_REQUIRE_VIRTUALENV=true
After saving this change and sourcing the ``~/.bashrc`` file with ``source ~/.bashrc``,
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.
@@ -34,22 +34,22 @@ remind you that an activated virtual environment is needed to install packages.
$ 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
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 ``pip.ini`` file is used by Windows operating systems and it can
Similarly, the :file:`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
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
@@ -70,7 +70,7 @@ add the following lines to this new file:
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:
the following to your :file:`~/.bashrc` file:
.. code-block:: console
@@ -78,7 +78,7 @@ the following to your ``~/.bashrc`` file:
PIP_REQUIRE_VIRTUALENV="" pip "$@"
}
After saving the changes and sourcing your ``~/.bashrc`` file you can now install
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.
@@ -96,7 +96,7 @@ start working on a new project (and in a new virtual environmen as a result).
Fortunately, you can configure pip in such a way that it tries to reuse already
installed packages.
On UNIX systems, you can add the following line to your ``.bashrc`` or ``.bash_profile``
On UNIX systems, you can add the following line to your :file:`.bashrc` or :file:`.bash_profile`
file.
.. code-block:: console
@@ -104,25 +104,25 @@ file.
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 ``.bashrc`` (or ``.bash_profile``)
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 ``pip.conf`` or ``pip.ini``
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 ``pip.ini`` file under ``[global]`` settings:
line to your :file:`pip.ini` file under ``[global]`` settings:
.. code-block:: console
download-cache = %HOME%\pip\cache
Similarly, on UNIX systems you should simply add the following line to your
``pip.conf`` file under ``[global]`` settings:
: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 ``pip.conf`` or ``pip.ini``
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.