Developer Documentation¶
Contributions¶
Contributions are more than welcome!
To get setup do the following;
mkvirtualenv --python=/usr/bin/python3.5 eater
git clone https://github.com/alexhayes/eater.git
cd eater
pip install -r requirements/dev.txt
Running Tests¶
Once you’ve checked out you should be able to run the tests;
tox
Or run all environments at once using detox;
detox
Or simply run with py.test;
py.test
Creating Documentation¶
cd docs
make apidoc clean html