First stab at Python3 OS X docs

This commit is contained in:
Adam Nelson
2016-03-14 14:28:01 -04:00
parent 3047288466
commit 8da905eae3
4 changed files with 146 additions and 18 deletions
+21 -14
View File
@@ -8,15 +8,22 @@ projects in separate places, by creating virtual Python environments for them.
It solves the "Project X depends on version 1.x but, Project Y needs 4.x"
dilemma, and keeps your global site-packages directory clean and manageable.
For example, you can work on a project which requires Django 1.3 while also
maintaining a project which requires Django 1.0.
For example, you can work on a project which requires Django 1.9 while also
maintaining a project which requires Django 1.8.
If you are using Python 3, make sure you run something like the following (or
have it in your env variables in `~/.bashrc`):
.. code-block:: console
$ export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3
virtualenv
----------
`virtualenv <http://pypi.python.org/pypi/virtualenv>`_ is a tool to create
isolated Python environments. virtualenv creates a folder which contains all the
necessary executables to use the packages that a Python project would need.
isolated Python environments. virtualenv creates a folder which contains all the
necessary executables to use the packages that a Python project would need.
Install virtualenv via pip:
@@ -43,13 +50,13 @@ in the current directory instead.
This creates a copy of Python in whichever directory you ran the command in,
placing it in a folder named :file:`venv`.
You can also use a Python interpreter of your choice.
You can also use the Python interpreter of your choice.
.. code-block:: console
$ virtualenv -p /usr/bin/python2.7 venv
$ virtualenv -p /usr/local/bin/python3 venv
This will use the Python interpreter in :file:`/usr/bin/python2.7`
This will use the Python interpreter in :file:`/usr/local/bin/python3`
2. To begin using the virtual environment, it needs to be activated:
@@ -57,9 +64,9 @@ This will use the Python interpreter in :file:`/usr/bin/python2.7`
$ source venv/bin/activate
The name of the current virtual environment will now appear on the left of
the prompt (e.g. ``(venv)Your-Computer:your_project UserName$)`` to let you know
that it's active. From now on, any package that you install using pip will be
The name of the current virtual environment will now appear on the left of
the prompt (e.g. ``(venv)Your-Computer:your_project UserName$)`` to let you know
that it's active. From now on, any package that you install using pip will be
placed in the ``venv`` folder, isolated from the global Python installation.
Install packages as usual, for example:
@@ -78,7 +85,7 @@ Install packages as usual, for example:
This puts you back to the system's default Python interpreter with all its
installed libraries.
To delete a virtual environment, just delete its folder. (In this case,
To delete a virtual environment, just delete its folder. (In this case,
it would be ``rm -rf venv``.)
After a while, though, you might end up with a lot of virtual environments
@@ -102,8 +109,8 @@ the current state of the environment packages. To do this, run
This will create a :file:`requirements.txt` file, which contains a simple
list of all the packages in the current environment, and their respective
versions. You can see the list of installed packages without the requirements
format using "pip list". Later it will be easier for a different developer
versions. You can see the list of installed packages without the requirements
format using "pip list". Later it will be easier for a different developer
(or you, if you need to re-create the environment) to install the same packages
using the same versions:
@@ -143,7 +150,7 @@ To install (make sure **virtualenv** is already installed):
.. code-block:: console
$ pip install virtualenvwrapper-win
In Windows, the default path for WORKON_HOME is %USERPROFILE%\Envs
Basic Usage