Increment version

.github/workflows/documentation.yaml

@@ -22,5 +22,5 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material mkdocs-jupyter
+      - run: pip install mkdocs-material mkdocstrings[python]
       - run: mkdocs gh-deploy --force

CHANGELOG.md

@@ -1,6 +1,19 @@
+### anonipy-0.1.0 (2024-07-16)
+
+- Add a pattern extractor named `PatternExtractor`, used to extract entities using spacy pattern matching and regex
+- Add a multi extractor named `MultiExtractor`, used to extract entities using multiple extractors
+- Add the `DATE_TRANSFORM_VARIANTS` constant to help with date generator
+- Refine the `Entity` implementation
+- Improve package documentation
+
+**BREAKING changes:**
+- Rename the `EntityExtractor` to `NERExtractor`
+- Rename the input variable `output_gen` to `sub_variant` in `DateGenerator`
+- Move the `regex` submodule from `anonipy.anonymize` to `anonipy.utils`
+
 ### anonipy-0.0.8 (2024-06-17)
 
-- Add automatic date format detection support to DateGenerator
+- Add automatic date format detection support to `DateGenerator`
 
 ### anonipy-0.0.7 (2024-06-06)
 
@@ -9,7 +22,7 @@
 
 ### anonipy-0.0.6 (2024-05-31)
 
-- Add GPU support and entity scores to EntityExtractor
+- Add GPU support and entity scores to `EntityExtractor`
 - Standardize the function naming in strategies
 
 ### anonipy-0.0.5 (2024-05-29)
@@ -20,22 +33,22 @@
 ### anonipy-0.0.4 (2024-05-27)
 
 - Add unit tests
-- Fix the LANGUAGES constant
+- Fix the `LANGUAGES` constant
 - Refine the Entity implementation
 - Update documentation
 
 ### anonipy-0.0.3 (2024-05-22)
 
-- Add read_json function
-- Add write_json function
+- Add `read_json` function
+- Add `write_json` function
 - Add blog post on anonymizing collections of documents
-- Fix the entity regex checking in EntityExtractor
-- Reduce the number of viable suggestions used to create a substitute in MaskLabelGenerator
+- Fix the entity regex checking in `EntityExtractor`
+- Reduce the number of viable suggestions used to create a substitute in `MaskLabelGenerator`
 - Add the entity label to the replacements in strategies
 
 ### anonipy-0.0.2 (2024-05-22)
 
-- Add write_file function
+- Add `write_file` function
 - Add blog to the documentation
 
 ### anonipy-0.0.1 (2024-05-21)

mkdocs.yml

@@ -55,8 +55,6 @@ plugins:
   - autorefs
   - search:
       separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
-  - mkdocs-jupyter:
-      include: ["*.ipynb"]
   - mkdocstrings:
       handlers:
         python:

pyproject.toml

@@ -32,7 +32,6 @@ dev = [
     "flake8",
     "python-githooks",
     "mkdocs-material",
-    "mkdocs-jupyter",
     "mkdocstrings[python]",
 ]
 test = [