- API
- Changelog
- (unreleased)
- 3.0.2 (2023-02-15)
- 3.0.1 (2023-12-20)
- 3.0.0 (2023-12-20)
- 2.5.0 (2023-11-28)
- 2.4.2 (2023-11-22)
- 2.4.3 (2023-11-22)
- 2.4.2 (2023-11-21)
- 2.4.1 (2023-11-15)
- 2.4.0 (2023-11-15)
- 2.3.1 (2023-11-01)
- 2.3.0 (2023-10-25)
- 2.2.0 (2023-09-28)
- 2.1.0 (2023-08-07)
- 2.0.3 (2023-04-06)
- 2.0.2 (2023-03-28)
- 2.0.1 (2022-12-09)
- 2.0.0 (2022-12-05)
- 1.0.8 (2021-11-29)
- 1.0.7 (2021-11-03)
- 1.0.6 (2021-10-06)
- 1.0.5 (2021-10-05)
- 1.0.4 (2021-10-05)
- 1.0.3 (2021-07-07)
- 1.0.2
- 1.0.1
- 1.0.0
- Contributing
- License
Contributing¶
Thanks for considering making an addition to this project! These contributing guidelines should help make your life easier.
Before starting, some things to consider:
For larger features, it would be helpful to get in touch first (through issue/email)
A lot of the logic is in
docdeid
, please consider making a PR there for things that are not specific todeduce
.deduce
is a rule-based de-identifierIn case you would like to see any rules added/removed/changed, a decent substantiation (with examples) of the potential improvement is useful
Setting up the environment¶
This project uses poetry for package management. Install it with
pip install poetry
Set up the environment is easy, just use
poetry install
The makefile contains some useful commands when developing:
make format
formats the package codemake lint
runs the linters (check the output)make clean
removes build/test artifacts, etc
And for docs:
make build-docs
builds the docs
Runing the tests¶
pytest .
PR checlist¶
Verify that tests are passing
Verify that tests are updated/added according to changes
Run the formatters (
make format
)Run the linters (
make lint
)Add a section to the changelog
Add a description to your PR
If all the steps above are followed, this ensures a quick review and release of your contribution.
Releasing¶
Readthedocs has a webhook connected to pushes on the main branch. It will trigger and update automatically.
Create a release on github, create a tag with the right version, manually copy and paste from the changelog
Build pipeline and release to PyPi trigger automatically on release
Any other questions/issues not covered here? Please just get in touch!