summaryrefslogtreecommitdiff
path: root/docs/source/installation.rst
blob: dd66a1f26024fad10515c79beb738ce66dd3a424 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.. _installation:

Installation
============

Stable Version
--------------

We recommend installing Pecan with ``pip``, but you can also try with
``easy_install``. Creating a spot in your environment where
Pecan can be isolated from other packages is best practice.

To get started with an environment for Pecan, we recommend creating a new
`virtual environment <http://www.virtualenv.org>`_ using `virtualenv 
<http://www.virtualenv.org>`_::

    $ virtualenv pecan-env
    $ cd pecan-env 
    $ source bin/activate

The above commands create a virtual environment and *activate* it. This
will isolate Pecan's dependency installations from your system packages, making
it easier to debug problems if needed.

Next, let's install Pecan::

    $ pip install pecan 


Development (Unstable) Version
------------------------------
If you want to run the latest development version of Pecan you will
need to install git and clone the repo from GitHub::

    $ git clone https://github.com/dreamhost/pecan.git -b next

Assuming your virtual environment is still activated, call ``setup.py`` to
install the development version.::

    $ cd pecan
    $ python setup.py develop

.. note::
    The ``next`` development branch is **very** volatile and is never
    recommended for production use.

Alternatively, you can also install from GitHub directly with ``pip``.::

    $ pip install -e git://github.com/dreamhost/pecan.git@next#egg=pecan