GitSubmoduleExample 0.0.0

Insert project description here

Project Short Description (default ini)

Project long description or extended summary goes in here (default ini)

Testing

This project uses pytest to run tests and also to test docstring examples.

Install the test dependencies.

$ pip install -r requirements_test.txt

Run the tests.

Developing

This project uses black to format code and flake8 for linting. We also support pre-commit to ensure these have been run. To configure your local environment please install these development dependencies and set up the commit hooks.

$ pip install black flake8 pre-commit
$ pre-commit install

Releasing

Releases are published automatically when a tag is pushed to GitHub.

# Set next version number
export RELEASE = x.x.x

# Create tags
git commit --allow -empty -m "Release $RELEASE"
git tag -a $RELEASE -m "Version $RELEASE"

# Push
git push upstream --tags