billingstack/doc/source/developing.rst

Developing BillingStack

Setting up a development environment

double: development; env

There are 2 ways to setting up a development environment * :doc:install/manual - Manual setup for a more distributed / semi production env * This: development-env

1. Clone the repo - see cloning-git for generic information:

   $ git clone http://github.com/billingstack/billingstack

2. Change directory to the BS directory:

   $ cd billingstack

3. Setup a virtualenv with all deps included for the core:

   $ python tools/install_venv.py

Now wait for it to be ready ( Take a coffe break? )

3. Active the virtualenv:

   $ source .venv/bin/activate

4. You're ready to have fun!

Running tests

Using tox you can test towards multiple different isolated environments.

For example if you want to test your PEP8 coverage that is needed to pass for a change to merge:

$ tox -e pep8

Running the actualy in Python 2.7 tests:

$ tox -e py27 -v -- -v