Keg Elements is the testing ground for ideas and code that will eventually make their way into Keg or an official Keg extension.
To develop on this project, begin by running our tests:
git clone https://github.com/level12/keg-elements keg-elements-src cd keg-elements-src tox
You can then examine tox.ini for insights into our development process. In particular, we:
- use
py.test
for testing (and coverage analysis) - use
flake8
for linting - store
pip
requirements files inrequirements/
- cache wheels in
requirements/wheelhouse
for faster & more reliable CI builds
Adding a dependency involves:
- If it's a run-time dependency, add to
setup.py
. - Adding the dependency to one of the requirements files in
requirements/
. - Running
requirements/build-wheelhouse.py
.
When updating the readme, use restview --long-description
to preview changes.
Please direct questions, comments, bugs, feature requests, etc. to: https://github.com/level12/keg-elements/issues
Very Alpha, expect changes.