Development

This project uses hatch for building.

Install latest development version

pip install git+https://github.com/cmc-python/modelmachine.git@main

For local development hatch will create virtualenv and install package with dependencies for you.

git clone https://github.com/cmc-python/modelmachine.git
cd modelmachine
ln -s $(pwd)/.githooks/* .git/hooks
pip install hatch
hatch shell dev

Now you are in local environment and command modelmachine is accessable

If separate environment is not needed for you, instead of last command:

pip install --editable .

Test local version:

hatch test

Show coverage:

hatch test --cover

hatch fmt

Publishing is automatic by github actions. To publish new version, create a release tag and release itself in github web interface.

git tag v0.x.y
git push --tags
# Now create a release in github web interface

If you prefer upload by yourself:

git tag v0.x.y
git push --tags
hatch clean
hatch build
hatch publish