Installing Development Environment¶
Your life will be a lot better if you use a virtualenv when working with python.
- Fork and Clone this repo
- Install python-pip and virtualenv if you do not already have it.
- Create a new virtualenv with
virtualenv -p python3 env.
- Actiavte the new virtualenv with
- Hack away!
Tests can be found in the
You can run tests with
If you want to run a specific test file you can do so with:
python -m unittest tests/circle/test_$MODULE.py
This project has two main types of tests.
- Unit tests. These are tests of specific functions using mocked API data.
- Integration tests. These are tests that actually hit the CircleCI API.
Unfortunately, due to the way that permissions work most of the currently
written tests will only work properly for the
levlazuser and token.
This project attempts to have 100% code coverage. when you run
code coverage is automatically ran. You can view the code coverage report
locally by opening up the index.html file in the
htmlcov directory that
gets created when you run
This project uses sphinx for documentation. You can generate the latest docs
locally by running
make docs. You can then view them by opening up the
index.html file in the