Developer

build-badge

Code Cleanliness

Please be sure to run autopep8 and flake8 before committing.

For autopep8, you could get it to auto format all your code.

autopep8 -i -r .
flake8

Unittest

Please be sure to add unittest to any changes. Ensure that all (relevent) unittests passes before you commit.

Run all unittests:

pytest

Test a single module:

pytest tsdb/tests/test_athena.py

Test a single function:

pytest tsdb/tests/test_athena.py -k test_wait_for_results_timeout

Documentation

Building

Create build the very documentation you are looking at now.

cd ~/environment/emagine-epython/docs
make html

Keep an eye on the output to make sure there are no errors or warnings.

Bad example:

build succeeded, 1 warning.

Good example:

build succeeded.

Preview

To view it locally. Simply open up ~/environment/emagine-epython/docs/build/html/index.html

On Cloud9. Run the below:

cd ~/environment/emagine-epython/docs/build
python -m http.server 8080

At the menu bar click Preview then Preview Running Application

Upload

The auto-build of the documentation isn’t there yet. So manually upload with.

While still in the docs directory:

aws s3 sync --acl public-read build/ s3://doc.epythoncloud.io/