Install latest version:
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
TODO
Prepare virtual environment and install dependencies
python -m venv venv
source ./venv/bin/activate
pip install --use-feature=2020-resolver -r requirements.txt -r requirements-dev.txt
source ./venv/bin/activate
inv format # format code
inv lint # check linting
inv docs # build docs
inv test # run unit tests
inv coverage # run unit tests with coverage
inv clean # clean build artifacts
inv dist # build distribution packages
inv release # upload the current version to pypi
The release consists of multiple steps which can be all done via the GitHub website:
- Go to create_release GitHub Action and click the
Run workflow
button. Enter the next version number or one of the magic keywords (patch, minor, major) and hit the greenRun workflow
button. - The action will prepare a new release and will end up with a new Pull Request
- Let the code owner review the PR and its changes and let the CI check whether everything builds successfully
- Once approved and merged, another GitHub action job starts which automatically will
- create a git tag
- create another Pull Request to merge the changes back to the
dev
branch - create a GitHub release with automatically derived release notes
- Done