Thank you for being interested in contributing to Glutil!
Note: you'll need python 3.6 or later installed.
-
Download this repo
git clone https://github.com/Journera/glutil.git
-
Create a virtual environment inside the project, and activate it
cd glutil python3 -m venv env . env/bin/activate
-
Install the development requirements
pip install -r requirements-dev.txt
-
And now you're ready to get started!
We strive for 100% test coverage, excluding only testing around AWS/Boto exception handling, because the way Boto manages exceptions is hard to fake.
A quick overview of our testing:
- Tests are run using
nosetests
. - Test coverage is generated using
coverage.py
,nosetests
will print out a report of coverage after it's run. flake8
as a linter to keep the code style at least somewhat consistent.- The
sure
library is used to make tests more readable than plain asserts.