A Python client for the Delphi Epidata API. Still in development.
Install with the following commands:
# Latest dev version
pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"
# PyPI version (not yet available)
pip install epidatpy
TODO
The following commands are available for developers:
make install # setup venv, install dependencies and local package
make test # run unit tests
make format # format code
make lint # check linting
make docs # build docs
make dist # build distribution packages
make release # upload the current version to pypi
make clean # clean build and docs artifacts
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