Skip to content

Commit

Permalink
docs: recommend python3 and virtualenv (#901)
Browse files Browse the repository at this point in the history
* docs: make it clear that python3 is the recommended version

* docs: recommend installing inside a virtualenv

And add a virtualenv primer.
  • Loading branch information
xrmx authored and mistercrunch committed Aug 9, 2016
1 parent 572c6ee commit b48101c
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/installation.rst
Expand Up @@ -4,8 +4,8 @@ Installation & Configuration
Getting Started
---------------

Caravel is currently only tested using Python 2.7.*. Python 3 support is
on the roadmap, Python 2.6 won't be supported.
Caravel is tested using Python 2.7 and Python 3.4+. Python 3 is the recommended version,
Python 2.6 won't be supported.


OS dependencies
Expand Down Expand Up @@ -48,6 +48,26 @@ attempt it, download `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_, and r
# You may also have to create C:\Temp
C:\> md C:\Temp

Python virtualenv
-----------------
It is recommended to install Caravel inside a virtualenv. Python 3 already ships virtualenv, for
Python 2 you need to install it. If it's packaged for your operating systems install it from there
otherwise you can install from pip: ::

pip install virtualenv

You can create and activate a virtualenv by: ::

# virtualenv is shipped in Python 3 as pyvenv
virtualenv venv
. ./venv/bin/activate

On windows the syntax for activating it is a bit different: ::

venv\Scripts\activate

Once you activated your virtualenv everything you are doing is confined inside the virtualenv.
To exit a virtualenv just type ``deactivate``.

Caravel installation and initialization
---------------------------------------
Expand Down

0 comments on commit b48101c

Please sign in to comment.