add logo, move docu into code

CHANGELOG.md

@@ -4,18 +4,32 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](https://semver.org/)
 
-## [Unreleased]
+
+## [0.7.0] 2025-01-06
+
+### Changed
+
+- move README documentation into plugin code
+
+### Added
+
+- logo
+
+
+## [0.6.1] 2025-01-06
 
 ### Changed
 
 - Update to plugin template 7.0.0
 
+
 ## [0.6.0] 2025-01-06
 
 ### Changed
 
 - Changed counter ontology upload to use `post_streamed` instead of `post`
 
+
 ## [0.5.0] 2024-01-03
 
 ### Added

README-public.md

@@ -23,11 +23,3 @@ cmemc admin workspace python install cmem-plugin-irdi
 [copier]: https://copier.readthedocs.io/
 [copier-shield]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json
 
-## Plugin Usage
-
-- All fields of the IRDI are configurable, minus `Item Code`, which is created by the plugin
-  - Created IRDIs are unique per configuration
-- Specify a graph that stores the state of `Item Codes`
-- Input and output paths are configurable
-  - if no input path is configured, values are read from the URIs of the input (Transformation Input)
-

README.md

@@ -11,14 +11,6 @@ Create unique International Registration Data Identifier (IRDI).
 - Use [pre-commit](https://pre-commit.com/) to avoid errors before commit.
 - This repository was created with [this copier template](https://github.com/eccenca/cmem-plugin-template).
 
-## Plugin Usage
-
-- All fields of the IRDI are configurable, minus `Item Code`, which is created by the plugin
-  - Created IRDIs are unique per configuration
-- Specify a graph that stores the state of `Item Codes`
-- Input and output paths are configurable
-  - if no input path is configured, values are read from the URIs of the input (Transformation Input) 
-
 [cmem-link]: https://documentation.eccenca.com
 [cmem-shield]: https://img.shields.io/endpoint?url=https://dev.documentation.eccenca.com/badge.json
 [poetry-link]: https://python-poetry.org/

cmem_plugin_irdi/workflow/irdi_plugin.py

@@ -5,7 +5,7 @@
 
 import rfc3987
 from cmem_plugin_base.dataintegration.context import ExecutionContext
-from cmem_plugin_base.dataintegration.description import Plugin, PluginParameter
+from cmem_plugin_base.dataintegration.description import Plugin, PluginParameter, Icon
 from cmem_plugin_base.dataintegration.entity import (
     Entities,
     Entity,
@@ -23,6 +23,18 @@
 # Version Identifier
 VI = "001"
 
+DOCUMENTATION = """Create unique [ECLASS](https://eclass.eu/support/technical-specification/structure-and-elements/irdi) IRDIs.
+
+IRDIs are unique for each combination of (non-advanced) parameters.
+If no input path is configured, values are read from the URIs of the input (Transformation Input).
+
+- All fields of the IRDI are configurable, except `Item Code`, which is created by the plugin.
+  - Created IRDIs are unique per configuration.
+- Specify a graph that stores the state of Item Codes.
+- Input and output paths are configurable.
+  - if no input path is configured, values are read from the URIs of the input (transformation input).
+"""
+
 PARAMETERS = [
     PluginParameter(
         name="graph",
@@ -56,13 +68,11 @@
 
 
 @Plugin(
-    label="Generate base36 IRDI",
-    description="Create unique [ECLASS]"
-    "(https://eclass.eu/support/technical-specification/structure-and-elements/irdi) IRDIs. "
-    "IRDIs are unique for each combination of (non-advanced) parameters. "
-    "If no input path is configured, values are read from the URIs of the input "
-    "(Transformation Input) ",
+    label="Generate base36 IRDIs",
+    description="Create unique ECLASS IRDIs.",
+    documentation=DOCUMENTATION,
     parameters=PARAMETERS,
+    icon=Icon(file_name="logo.svg", package=__package__)
 )
 class IrdiPlugin(WorkflowPlugin):
     """IRDI Plugin"""