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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
.. _virtualenvwrapper: https://pypi.python.org/pypi/virtualenvwrapper
.. _virtualenv: https://pypi.python.org/pypi/virtualenv
.. _pip: https://pypi.python.org/pypi/pip
.. _Fabric: http://www.fabfile.org/
.. _Python: https://www.python.org/
.. _Git: https://git-scm.com/
Setting up a circuits Development Environment
=============================================
This is the recommended way to setup a development enviornment
for developing with or on circuits.
.. note:: This document *assumes* you already have a working `Python`_
environment with a minimum `Python`_ version of 2.7 as well
as `pip`_ already installed.
Prequisites
-----------
It is highly recommended that you install and use `virtualenv`_ for all your
`Python`_ development and production deployments (*not just circuits*).
It is also convenient to install and use the accompanying shell scripts
and tools `virtualenvwrapper`_ which adds a nice set of workflows
and functions useful for both development and deployments.
.. code-block:: bash
$ pip install -U virtualenvwrapper
$ source $(which virtualenvwrapper.sh)
.. note:: You should put ``source $(which virtualenvwrapper.sh)`` in either
your ``$HOME/.bashrc`` or ``$HOME/.profile`` depending on how you
login and interact with your terminals.
In addition to the above recommendations you must also have a `Git`_ client
installed and ready to use as well as your Editor/IDE of choice ready to use.
Getting Started
---------------
1. `Fork circuits <https://github.com/circuits/circuits#fork-destination-box>`_
(*if you haven't done so already*)
2. Clone your forked repository using `Git`_
3. Create a new virtual environment using `virtualenvwrapper`_
4. Install the `Development Requirements <https://github.com/circuits/circuits/blob/master/requirements-dev.txt>`_
5. Install circuits in "develop" mode
And you're done!
Example:
.. code-block:: bash
$ git clone git@github.com:prologic/circuits.git
$ cd circuits
$ mkvirtualenv circuits
$ pip install -r requirements-dev.txt
$ python setup.py develop
Alternatively if you already have `Fabric`_ installed:
.. code-block:: bash
$ git clone git@github.com:prologic/circuits.git
$ cd circuits
$ mkvirtualenv circuits
$ fab develop
|
