Skip to content

Commit

Permalink
Merge branch 'master' into db_permissions
Browse files Browse the repository at this point in the history
  • Loading branch information
bkyryliuk authored Aug 10, 2016
2 parents 3839c03 + b48101c commit c3ca344
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ Lint the project with:

# for python changes
flake8 changes tests
flake8 changes caravel

# for javascript
npm run lint
Expand Down
24 changes: 22 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
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 c3ca344

Please sign in to comment.