DP Wizard Templates

DP Wizard Templates lets you use syntactically valid Python code as a template. Templates can be filled and composed to generate entire notebooks.

See the documentation for more information.

Development

Getting Started

On MacOS:

$ git clone https://github.com/opendp/dp-wizard-templates.git
$ cd dp-wizard-templates
$ brew install [email protected]
$ python3.10 -m venv .venv
$ source .venv/bin/activate

You can now install dependencies:

$ pip install -r requirements-dev.txt
$ pre-commit install
$ flit install

Tests should pass, and code coverage should be complete (except blocks we explicitly ignore):

$ scripts/ci.sh

Release

• Make sure you're up to date, and have the git-ignored credentials file .pypirc.
• Make one last feature branch with the new version number in the name:
  • Run scripts/changelog.py to update the CHANGELOG.md.
  • Review the updates and pull a couple highlights to the top.
  • Bump dp_wizard/VERSION, and add the new number at the top of the CHANGELOG.md.
  • Commit your changes, make a PR, and merge this branch to main.
• Update main with the latest changes: git checkout main; git pull
• Publish: flit publish --pypirc .pypirc