README.md

SelfHacked Util

Note: Some files are not included in coverage. See .coveragerc for details.

Developing this project

• Setting up:

  pip install -e .[dev]

• Testing:

  Local testing:

  pytest

  Push your own branch and tests will run on Travis.

• Test Coverage

  pytest --cov

  To see lines not covered in tests,

  pytest --cov --cov-report term-missing

Using this project

• Development version:

  pip install -e .

• GitHub version:

  pip install git+git://github.com/SelfHacked/selfhacked-util.git#egg=selfhacked-util

  Installs from the master branch by default. To specify a branch/tag/commit,

  pip install git+git://github.com/SelfHacked/selfhacked-util.git@{ref}#egg=selfhacked-util

• Installing extras

  There are three extra options (see extras_require in setup.py): aws, django and all. To install an extra, simply add [xxx] at the end (no space).