Merge pull request #14 from NetherlandsForensicInstitute/0.9.1_added_transformers_and_updated_dependencies

update the template for release 0.9.4: added transformer and added doc for transformer

Author: kean-nfi

README.md

@@ -1,4 +1,4 @@
-# Hansken Extraction Plugin template for Python based on version 0.8.3
+# Hansken Extraction Plugin template for Python based on version 0.9.4
 
 This repository contains a template for a Hansken extraction plugin written in Python.
 This template is a minimal but complete example of a plugin implementation, including all required build steps.
@@ -14,6 +14,8 @@ To transform this skeleton in your plugin your may want to:
 * Create test input data in the folder [`testdata/input`](testdata/input)
   (refer to the [SDK manual for more details on how to define test data](https://netherlandsforensicinstitute.github.io/hansken-extraction-plugin-sdk-documentation/latest/dev/concepts/test_framework.html))
 * Implement your plugin `process()` logic in [`plugin.py`](plugin.py)
+* (Optional) Implement your own transformers(https://netherlandsforensicinstitute.github.io/hansken-extraction-plugin-sdk-documentation/latest/dev/python/transformers.html) in the example_transformer() [`plugin.py`](plugin.py),
+  or remove the transformer method from the plugin.
 * Add your plugin dependencies to [`requirements.in`](requirements.in)
   and regenerate `requirements.txt` by calling `tox -e upgrade`
 * Add any system dependencies to the [`Dockerfile`](Dockerfile)

plugin.py

@@ -1,5 +1,6 @@
 from hansken_extraction_plugin.api.extraction_plugin import ExtractionPlugin
 from hansken_extraction_plugin.api.plugin_info import Author, MaturityLevel, PluginId, PluginInfo, PluginResources
+from hansken_extraction_plugin.decorators.transformer import transformer
 from hansken_extraction_plugin.runtime.extraction_plugin_runner import run_with_hanskenpy
 from logbook import Logger
 
@@ -26,9 +27,16 @@ def process(self, trace, data_context):
         log.info(f"processing trace {trace.get('name')}")
         # Add your plugin implementation here
 
+    @transformer
+    def example_transformer(self, number: int) -> int:
+        # Optional transformer method to run this method with a REST call
+        # See detail at:
+        #  https://netherlandsforensicinstitute.github.io/hansken-extraction-plugin-sdk-documentation/latest/dev/python/transformers.html
+        return number + 1
 
 if __name__ == '__main__':
-    # optional main method to run your plugin with Hansken.py
-    # see detail at:
+    # Optional main method to run your plugin with Hansken.py
+    # See detail at:
     #  https://netherlandsforensicinstitute.github.io/hansken-extraction-plugin-sdk-documentation/latest/dev/python/hanskenpy.html
     run_with_hanskenpy(Plugin)
+

requirements.in

@@ -1 +1 @@
-hansken-extraction-plugin==0.8.3
+hansken-extraction-plugin == 0.9.4

requirements.txt

@@ -1,34 +1,34 @@
-certifi==2024.8.30
+certifi==2025.1.31
     # via requests
-charset-normalizer==3.3.2
+charset-normalizer==3.4.1
     # via requests
 decorator==5.1.1
     # via hansken
 docker==7.1.0
     # via hansken-extraction-plugin
-grpcio==1.66.2
+grpcio==1.70.0
     # via hansken-extraction-plugin
-hansken==2024.7.15
+hansken==2024.12.4
     # via hansken-extraction-plugin
-hansken-extraction-plugin==0.8.3
+hansken-extraction-plugin==0.9.4
     # via -r requirements.in
 idna==3.10
     # via requests
 ijson==3.3.0
     # via hansken
 iso8601==2.1.0
     # via hansken
-logbook==1.7.0.post0
+logbook==1.8.0
     # via
     #   hansken
     #   hansken-extraction-plugin
-more-itertools==10.5.0
+more-itertools==10.6.0
     # via hansken
-protobuf==5.28.2
+protobuf==5.29.3
     # via hansken-extraction-plugin
 python-dateutil==2.9.0.post0
     # via hansken
-pytz==2024.2
+pytz==2025.1
     # via hansken-extraction-plugin
 requests==2.32.3
     # via
@@ -37,13 +37,13 @@ requests==2.32.3
     #   requests-toolbelt
 requests-toolbelt==1.0.0
     # via hansken
-six==1.16.0
+six==1.17.0
     # via python-dateutil
 tabulate==0.9.0
     # via hansken
 typing-extensions==4.12.2
     # via hansken-extraction-plugin
-urllib3==2.2.3
+urllib3==2.3.0
     # via
     #   docker
     #   requests

tox.ini

@@ -10,11 +10,11 @@ commands = test_plugin --standalone plugin.py
 commands = test_plugin --standalone plugin.py --regenerate
 
 [testenv:package]
-deps = hansken-extraction-plugin==0.8.3
+deps = hansken-extraction-plugin==0.9.4
 commands = build_plugin . {posargs}
 
 [testenv:integration-test]
-deps = hansken-extraction-plugin==0.8.3
+deps = hansken-extraction-plugin==0.9.4
 commands =
   build_plugin . plugin-to-test {posargs}
   test_plugin --docker plugin-to-test