cmem-plugin-uuid 1.0.0rc1__tar.gz

cmem_plugin_uuid-1.0.0rc1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 CMEM
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cmem_plugin_uuid-1.0.0rc1/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.1
+Name: cmem-plugin-uuid
+Version: 1.0.0rc1
+Summary: Create universally unique identifiers (UUIDs) versions 1, 3, 4, 5, 6, 7 and 8 in transformations.
+Home-page: https://github.com/eccenca/cmem-plugin-uuid
+License: Apache-2.0
+Keywords: eccenca Corporate Memory,plugin,UUID
+Author: eccenca GmbH
+Author-email: cmempy-developer@eccenca.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Plugins
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: cmem-plugin-base (>=4.3.0,<5.0.0)
+Requires-Dist: uuid6 (>=2023.5.2)
+Description-Content-Type: text/markdown
+
+# cmem-plugin-uuid
+
+Create universally unique identifiers (UUIDs) versions 1, 3, 4, 5, 6, 7 and 8 in transformations.
+
+## Installation
+
+`cmemc -c my-cmem admin workspace python install cmem-plugin-uuid`
+
+## UUID1
+
+UUID1 version is generated from a host ID, sequence number, and the current time.
+
+### Parameters
+
+#### Node
+
+Node value in the form "01:23:45:67:89:AB", "01-23-45-67-89-AB", or "0123456789AB".
+If not given, [`uuid.getnode()`](https://docs.python.org/3/library/uuid.html#uuid.getnode) is used to 
+attempt to obtain the hardware address. If this is unsuccessful a random 48-bit number is chosen.
+
+Default value: _None_  
+ID: `node`
+
+#### Clock sequence
+
+If clock sequence is given, it is used as the sequence number, otherwise a random 14-bit sequence number is chosen.
+
+Default value: _None_  
+ID: `clock_seq`
+
+<br>
+
+## UUID3
+
+UUID version 3 is a reproducible UUID based on the MD5 hash of a namespace identifier (which is a UUID) and a name
+(which is a string).
+
+
+### Parameters
+
+#### Namespace
+
+The namespace can be entered manually or selected from the namespace UUIDs defined in
+[RFC 4122](https://www.rfc-editor.org/rfc/rfc4122):
+
+- Namespace DNS: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 (*namespace_dns*)
+- Namespace URL: 6ba7b811-9dad-11d1-80b4-00c04fd430c8 (*namespace_url*)
+- Namespace OID: 6ba7b812-9dad-11d1-80b4-00c04fd430c8 (*namespace_oid*)
+- Namespace X500: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 (*namespace_x500*)
+
+If none of the predefined namespace UUIDs is selected, the input namespace is either directly
+interpreted as a UUID, or used to derive a UUID (see parameter _Namespace as UUID_). If no namespace is given,
+the output is the same as that of the standard CMEM UUID operator with input value.
+
+Default value: _none_  
+ID: `namespace`
+
+#### Use input as namespace
+
+If enabled, the input value is used for the namespace.
+
+Default value: _False_  
+ID: `input_as_namespace`
+
+#### Namespace as UUID
+
+Applies only if none of the pre-defined namespaces is selected. If enabled, the namespace string
+needs to be a valid UUID. Otherwise, the namespace UUID is a UUIDv1 derived from the MD5 
+hash of the namespace string.
+
+Default value: _False_  
+ID: `namespace_as_uuid`
+
+<br>
+
+
+## UUID4
+
+UUID version 4 specifies a random UUID. This plugin is equivalent to the standard CMEM UUID operator without input value.
+
+<br>
+
+
+## UUID5
+
+UUID version 5 is a reproducible UUID based on the SHA1 hash of a namespace identifier (which is a UUID) and a
+name (which is a string).
+
+### Parameters
+
+#### Namespace
+
+The namespace can be entered manually or selected from the namespace UUIDs defined in
+[RFC 4122](https://www.rfc-editor.org/rfc/rfc4122):
+
+- Namespace DNS: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 (*namespace_dns*)
+- Namespace URL: 6ba7b811-9dad-11d1-80b4-00c04fd430c8 (*namespace_url*)
+- Namespace OID: 6ba7b812-9dad-11d1-80b4-00c04fd430c8 (*namespace_oid*)
+- Namespace X500: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 (*namespace_x500*)
+
+If none of the predefined namespace UUIDs is selected, the input namespace is either directly
+interpreted as a UUID, or used to derive a UUID (see parameter _Namespace as UUID_).
+
+Default value: _none_  
+ID: `namespace`
+
+#### Namespace as UUID
+
+Applies only if none of the pre-defined namespaces is selected. If enabled, the namespace string
+needs to be a valid UUID. Otherwise, the namespace UUID is a UUIDv1 derived from the SHA1 
+hash of the namespace string.
+
+Default value: _False_  
+ID: `namespace_as_uuid`
+
+<br>
+
+## UUID6
+
+UUID6 version is generated from a host ID, sequence number, and the current time.
+UUID version 6 is a field-compatible version of UUIDv1, reordered for improved DB locality. 
+
+### Parameters
+
+#### Node
+
+Node value in the form "01:23:45:67:89:AB", "01-23-45-67-89-AB", or "0123456789AB".
+If not given, a random 48-bit sequence number is chosen.
+
+Default value: _None_  
+ID: `node`
+
+#### Clock sequence
+
+If clock sequence is given, it is used as the sequence number, otherwise a random 14-bit number is chosen.
+
+Default value: _None_  
+ID: `clock_seq`
+
+<br>
+
+## UUID7
+
+UUID version 7 features a time-ordered value field derived from the
+widely implemented and well known Unix Epoch timestamp source, the
+number of milliseconds since midnight 1 Jan 1970 UTC, leap seconds
+excluded, as well as improved entropy characteristics over versions
+1 or 6.
+
+<br>
+
+## UUID8
+
+UUID version 8 features a time-ordered value field derived from the
+widely implemented and well known Unix Epoch timestamp source, the
+number of nanoseconds since midnight 1 Jan 1970 UTC, leap seconds
+excluded.
+
+<br>
+
+## UUID1 to UUID6
+
+Generate a UUID version 6 from a UUID version 1. The input needs to be a valid UUIDv1
+hexdecimal string.
+
+<br>
+
+## UUID Version
+
+Outputs the UUID version from a UUID input string.
+
+<br>
+
+## UUID Convert
+
+Convert a UUID from one format to another. The plugin accepts strings in the correct format, however, the log will show
+a warning if the input does not comply with the standard specified in [RFC 4122](https://www.rfc-editor.org/rfc/rfc4122) and the 
+[proposed updates](https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-01.html).
+
+### Parameters
+
+#### From
+
+The input format
+
+Options:
+
+- **UUID/32-character hexadecimal string** (*uuid_hex*):
+
+  A standard UUID or a UUID as a 32-character lowercase hexadecimal string.
+- **128-bit integer** (_int_):
+
+  The UUID as a 128-bit integer.
+- **URN** (_urn_):
+
+  The UUID as a URN.
+
+Default value: _UUID/32-character lowercase hexadecimal string_   
+ID: `from_format`
+
+#### To
+
+The output format
+
+Options:
+
+- **UUID** (_uuid_):
+
+  A standard UUID.
+- **32-character lowercase hexadecimal string** (_hex_):
+
+  The UUID as a 32-character lowercase hexadecimal string.
+- **128-bit integer** (_int_):
+
+  The UUID as a 128-bit integer.
+- **URN** (_urn_):
+
+  The UUID as a URN as specified in [RFC 4122](https://www.rfc-editor.org/rfc/rfc4122).
+
+Default value: _32-character lowercase hexadecimal string_  
+ID: `to_format`
+

cmem_plugin_uuid-1.0.0rc1/README-public.md

@@ -0,0 +1,221 @@
+# cmem-plugin-uuid
+
+Create universally unique identifiers (UUIDs) versions 1, 3, 4, 5, 6, 7 and 8 in transformations.
+
+## Installation
+
+`cmemc -c my-cmem admin workspace python install cmem-plugin-uuid`
+
+## UUID1
+
+UUID1 version is generated from a host ID, sequence number, and the current time.
+
+### Parameters
+
+#### Node
+
+Node value in the form "01:23:45:67:89:AB", "01-23-45-67-89-AB", or "0123456789AB".
+If not given, [`uuid.getnode()`](https://docs.python.org/3/library/uuid.html#uuid.getnode) is used to 
+attempt to obtain the hardware address. If this is unsuccessful a random 48-bit number is chosen.
+
+Default value: _None_  
+ID: `node`
+
+#### Clock sequence
+
+If clock sequence is given, it is used as the sequence number, otherwise a random 14-bit sequence number is chosen.
+
+Default value: _None_  
+ID: `clock_seq`
+
+<br>
+
+## UUID3
+
+UUID version 3 is a reproducible UUID based on the MD5 hash of a namespace identifier (which is a UUID) and a name
+(which is a string).
+
+
+### Parameters
+
+#### Namespace
+
+The namespace can be entered manually or selected from the namespace UUIDs defined in
+[RFC 4122](https://www.rfc-editor.org/rfc/rfc4122):
+
+- Namespace DNS: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 (*namespace_dns*)
+- Namespace URL: 6ba7b811-9dad-11d1-80b4-00c04fd430c8 (*namespace_url*)
+- Namespace OID: 6ba7b812-9dad-11d1-80b4-00c04fd430c8 (*namespace_oid*)
+- Namespace X500: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 (*namespace_x500*)
+
+If none of the predefined namespace UUIDs is selected, the input namespace is either directly
+interpreted as a UUID, or used to derive a UUID (see parameter _Namespace as UUID_). If no namespace is given,
+the output is the same as that of the standard CMEM UUID operator with input value.
+
+Default value: _none_  
+ID: `namespace`
+
+#### Use input as namespace
+
+If enabled, the input value is used for the namespace.
+
+Default value: _False_  
+ID: `input_as_namespace`
+
+#### Namespace as UUID
+
+Applies only if none of the pre-defined namespaces is selected. If enabled, the namespace string
+needs to be a valid UUID. Otherwise, the namespace UUID is a UUIDv1 derived from the MD5 
+hash of the namespace string.
+
+Default value: _False_  
+ID: `namespace_as_uuid`
+
+<br>
+
+
+## UUID4
+
+UUID version 4 specifies a random UUID. This plugin is equivalent to the standard CMEM UUID operator without input value.
+
+<br>
+
+
+## UUID5
+
+UUID version 5 is a reproducible UUID based on the SHA1 hash of a namespace identifier (which is a UUID) and a
+name (which is a string).
+
+### Parameters
+
+#### Namespace
+
+The namespace can be entered manually or selected from the namespace UUIDs defined in
+[RFC 4122](https://www.rfc-editor.org/rfc/rfc4122):
+
+- Namespace DNS: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 (*namespace_dns*)
+- Namespace URL: 6ba7b811-9dad-11d1-80b4-00c04fd430c8 (*namespace_url*)
+- Namespace OID: 6ba7b812-9dad-11d1-80b4-00c04fd430c8 (*namespace_oid*)
+- Namespace X500: 6ba7b814-9dad-11d1-80b4-00c04fd430c8 (*namespace_x500*)
+
+If none of the predefined namespace UUIDs is selected, the input namespace is either directly
+interpreted as a UUID, or used to derive a UUID (see parameter _Namespace as UUID_).
+
+Default value: _none_  
+ID: `namespace`
+
+#### Namespace as UUID
+
+Applies only if none of the pre-defined namespaces is selected. If enabled, the namespace string
+needs to be a valid UUID. Otherwise, the namespace UUID is a UUIDv1 derived from the SHA1 
+hash of the namespace string.
+
+Default value: _False_  
+ID: `namespace_as_uuid`
+
+<br>
+
+## UUID6
+
+UUID6 version is generated from a host ID, sequence number, and the current time.
+UUID version 6 is a field-compatible version of UUIDv1, reordered for improved DB locality. 
+
+### Parameters
+
+#### Node
+
+Node value in the form "01:23:45:67:89:AB", "01-23-45-67-89-AB", or "0123456789AB".
+If not given, a random 48-bit sequence number is chosen.
+
+Default value: _None_  
+ID: `node`
+
+#### Clock sequence
+
+If clock sequence is given, it is used as the sequence number, otherwise a random 14-bit number is chosen.
+
+Default value: _None_  
+ID: `clock_seq`
+
+<br>
+
+## UUID7
+
+UUID version 7 features a time-ordered value field derived from the
+widely implemented and well known Unix Epoch timestamp source, the
+number of milliseconds since midnight 1 Jan 1970 UTC, leap seconds
+excluded, as well as improved entropy characteristics over versions
+1 or 6.
+
+<br>
+
+## UUID8
+
+UUID version 8 features a time-ordered value field derived from the
+widely implemented and well known Unix Epoch timestamp source, the
+number of nanoseconds since midnight 1 Jan 1970 UTC, leap seconds
+excluded.
+
+<br>
+
+## UUID1 to UUID6
+
+Generate a UUID version 6 from a UUID version 1. The input needs to be a valid UUIDv1
+hexdecimal string.
+
+<br>
+
+## UUID Version
+
+Outputs the UUID version from a UUID input string.
+
+<br>
+
+## UUID Convert
+
+Convert a UUID from one format to another. The plugin accepts strings in the correct format, however, the log will show
+a warning if the input does not comply with the standard specified in [RFC 4122](https://www.rfc-editor.org/rfc/rfc4122) and the 
+[proposed updates](https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-01.html).
+
+### Parameters
+
+#### From
+
+The input format
+
+Options:
+
+- **UUID/32-character hexadecimal string** (*uuid_hex*):
+
+  A standard UUID or a UUID as a 32-character lowercase hexadecimal string.
+- **128-bit integer** (_int_):
+
+  The UUID as a 128-bit integer.
+- **URN** (_urn_):
+
+  The UUID as a URN.
+
+Default value: _UUID/32-character lowercase hexadecimal string_   
+ID: `from_format`
+
+#### To
+
+The output format
+
+Options:
+
+- **UUID** (_uuid_):
+
+  A standard UUID.
+- **32-character lowercase hexadecimal string** (_hex_):
+
+  The UUID as a 32-character lowercase hexadecimal string.
+- **128-bit integer** (_int_):
+
+  The UUID as a 128-bit integer.
+- **URN** (_urn_):
+
+  The UUID as a URN as specified in [RFC 4122](https://www.rfc-editor.org/rfc/rfc4122).
+
+Default value: _32-character lowercase hexadecimal string_  
+ID: `to_format`

cmem_plugin_uuid-1.0.0rc1/cmem_plugin_uuid/__init__.py

@@ -0,0 +1 @@
+"""uuid - main package"""

cmem_plugin_uuid-1.0.0rc1/cmem_plugin_uuid/transform/__init__.py

@@ -0,0 +1,464 @@
+"""UUID transform plugin module"""
+import re
+import uuid
+from collections.abc import Sequence
+
+import uuid6
+from cmem_plugin_base.dataintegration.description import Plugin, PluginParameter
+from cmem_plugin_base.dataintegration.plugins import TransformPlugin
+from cmem_plugin_base.dataintegration.types import BoolParameterType
+
+from cmem_plugin_uuid.utils import (
+    clock_seq_to_int,
+    get_namespace_uuid,
+    namespace_hex,
+    node_to_int,
+    uuid3_uuid5_namespace_param,
+    uuid_convert_param_in,
+    uuid_convert_param_out,
+)
+
+
+@Plugin(
+    label="UUID1",
+    categories=["Value", "Identifier"],
+    description="Generate a UUIDv1 from a host ID, sequence number, and the " "current time",
+    documentation="""
+UUIDv1 is generated from a host ID, sequence number, and the current
+time.
+
+""",
+    parameters=[
+        PluginParameter(
+            name="node",
+            label="Node (default: hardware address)",
+            description=(
+                'Node value in the form "01:23:45:67:89:AB", 01-23-45-67-89-AB", or '
+                '"0123456789AB". If not given, it is attempted to obtain the hardware '
+                "address. If this is unsuccessful, a random 48-bit number is chosen."
+            ),
+            default_value=None,
+        ),
+        PluginParameter(
+            name="clock_seq",
+            label="Clock sequence (default: random)",
+            description=(
+                "If clock sequence is given, it is used as the sequence number. "
+                "Otherwise a random 14-bit sequence number is chosen."
+            ),
+            default_value=None,
+        ),
+    ],
+)
+class UUID1(TransformPlugin):
+    """UUID1 Transform Plugin"""
+
+    def __init__(
+        self,
+        node: str,
+        clock_seq: str,
+    ):
+        self.node = node_to_int(node) if node else None
+        self.clock_seq = clock_seq_to_int(clock_seq) if clock_seq else None
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [
+                    str(uuid.uuid1(node=self.node, clock_seq=self.clock_seq)) for _ in collection
+                ]
+        else:
+            result = [str(uuid.uuid1(node=self.node, clock_seq=self.clock_seq))]
+        return result
+
+
+@Plugin(
+    label="UUID3",
+    categories=["Value", "Identifier"],
+    description="Generate a UUIDv3",
+    documentation="""UUID3 is based on the MD5 hash of a namespace identifier (which
+    is a UUID) and a name (which is a string).""",
+    parameters=[
+        PluginParameter(
+            param_type=uuid3_uuid5_namespace_param,
+            name="namespace",
+            label="Namespace",
+            description="The namespace.",
+            default_value="",
+        ),
+        PluginParameter(
+            param_type=BoolParameterType(),
+            name="namespace_as_uuid",
+            label="Namespace as UUID",
+            description=(
+                "Applies only if none of the pre-defined namespaces is selected. If "
+                "enabled, the namespace string needs to be a valid UUID. "
+                "Otherwise, the namespace UUID is a UUIDv1 derived from the MD5 hash "
+                "of the namespace string."
+            ),
+            default_value=False,
+        ),
+    ],
+)
+class UUID3(TransformPlugin):
+    """UUID3 Transform Plugin"""
+
+    def __init__(
+        self,
+        namespace: str,
+        namespace_as_uuid: bool | None,
+    ):
+        self.namespace = namespace
+        self.namespace_as_uuid = namespace_as_uuid
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        namespace_uuid = get_namespace_uuid(
+            namespace_as_uuid=self.namespace_as_uuid,
+            namespace=self.namespace,
+            uuid_version=3,
+        )
+
+        if len(inputs) != 0:
+            for collection in inputs:
+                for _ in collection:
+                    if not self.namespace.strip():
+                        result += [str(uuid.UUID(hex=namespace_hex(_, 3), version=3))]
+                    else:
+                        result += [str(uuid.uuid3(namespace_uuid, _))]  # type: ignore[arg-type]
+        else:
+            raise ValueError("No input for UUID3")
+        return result
+
+
+@Plugin(
+    label="UUID4",
+    categories=["Value", "Identifier"],
+    description="Generate a random UUIDv4.",
+    documentation="""UUIDv4 specifies a random UUID.""",
+)
+class UUID4(TransformPlugin):
+    """UUID4 Transform Plugin"""
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [str(uuid.uuid4()) for _ in collection]
+        else:
+            result = [str(uuid.uuid4())]
+        return result
+
+
+@Plugin(
+    label="UUID5",
+    categories=["Value", "Identifier"],
+    description="Generate a UUIDv5",
+    documentation="""UUID5 is based on the SHA1 hash of a namespace identifier (which
+    is a UUID) and a name (which is a string).""",
+    parameters=[
+        PluginParameter(
+            param_type=uuid3_uuid5_namespace_param,
+            name="namespace",
+            label="Namespace",
+            description="If 'namespace' is not given, the input string is used.",
+            default_value="",
+        ),
+        PluginParameter(
+            param_type=BoolParameterType(),
+            name="namespace_as_uuid",
+            label="Namespace as UUID",
+            description=(
+                "Applies only if none of the pre-defined namespaces is selected. If "
+                "enabled, the namespace string needs to be a valid UUID. "
+                "Otherwise, the namespace UUID is a UUIDv1 derived from the SHA1 hash "
+                "of the namespace string."
+            ),
+            default_value=False,
+        ),
+    ],
+)
+class UUID5(TransformPlugin):
+    """UUID5 Transform Plugin"""
+
+    def __init__(
+        self,
+        namespace: str,
+        namespace_as_uuid: bool | None,
+    ):
+        self.namespace = namespace
+        self.namespace_as_uuid = namespace_as_uuid
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        namespace_uuid = get_namespace_uuid(
+            namespace_as_uuid=self.namespace_as_uuid,
+            namespace=self.namespace,
+            uuid_version=5,
+        )
+
+        if len(inputs) != 0:
+            for collection in inputs:
+                for _ in collection:
+                    if not self.namespace.strip():
+                        result += [str(uuid.UUID(hex=namespace_hex(_, 5), version=5))]
+                    else:
+                        result += [str(uuid.uuid5(namespace_uuid, _))]  # type: ignore[arg-type]
+        else:
+            raise ValueError("No input for UUID5")
+        return result
+
+
+@Plugin(
+    label="UUID6",
+    categories=["Value", "Identifier"],
+    description="Generate a UUIDv6 from a host ID, sequence number, and the " "current time",
+    documentation="""
+UUIDv6 is generated from a host ID, sequence number, and the current
+time.
+
+UUIDv6 is a field-compatible version of UUIDv1, reordered for
+improved DB locality. It is expected that UUIDv6 will primarily be
+used in contexts where there are existing v1 UUIDs. Systems that do
+not involve legacy UUIDv1 SHOULD consider using UUIDv7 instead.
+""",
+    parameters=[
+        PluginParameter(
+            name="node",
+            label="Node (default: hardware address)",
+            description=(
+                'Node value in the form "01:23:45:67:89:AB", 01-23-45-67-89-AB", or '
+                '"0123456789AB". If not given, a random 48-bit number is chosen.'
+            ),
+            default_value="",
+        ),
+        PluginParameter(
+            name="clock_seq",
+            label="Clock sequence (default: random)",
+            description=(
+                "If clock sequence is given, it is used as the sequence number. "
+                "Otherwise a random 14-bit number is chosen."
+            ),
+            default_value="",
+        ),
+    ],
+)
+class UUID6(TransformPlugin):
+    """UUID6 Transform Plugin"""
+
+    def __init__(
+        self,
+        node: str,
+        clock_seq: str,
+    ):
+        self.node = node_to_int(node) if node else None
+        self.clock_seq = clock_seq_to_int(clock_seq) if clock_seq else None
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [
+                    str(uuid6.uuid6(node=self.node, clock_seq=self.clock_seq)) for _ in collection
+                ]
+        else:
+            result = [str(uuid6.uuid6(node=self.node, clock_seq=self.clock_seq))]
+        return result
+
+
+@Plugin(
+    label="UUID1 to UUID6",
+    categories=["Value", "Identifier"],
+    description="Generate UUIDv6 from a UUIDv1.",
+    documentation="""
+UUIDv6 is a field-compatible version of UUIDv1, reordered for
+improved DB locality. It is expected that UUIDv6 will primarily be
+used in contexts where there are existing v1 UUIDs. Systems that do
+not involve legacy UUIDv1 SHOULD consider using UUIDv7 instead.
+""",
+)
+class UUID1ToUUID6(TransformPlugin):
+    """UUID1 to UUID6 Transform Plugin"""
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                for _ in collection:
+                    try:
+                        result += [str(uuid6.uuid1_to_uuid6(uuid.UUID(_)))]
+                    except ValueError as exc:
+                        raise ValueError(f"{_} is not a valid UUIDv1 string") from exc
+        else:
+            raise ValueError("No input for UUID1 to UUID6")
+        return result
+
+
+@Plugin(
+    label="UUID7",
+    categories=["Value", "Identifier"],
+    description="Generate a UUIDv7 from a random number, and the current time.",
+    documentation="""UUIDv7 features a time-ordered value field derived from the
+widely implemented and well known Unix Epoch timestamp source, the
+number of milliseconds since midnight 1 Jan 1970 UTC, leap seconds
+excluded. As well as improved entropy characteristics over versions
+1 or 6.
+Implementations SHOULD utilize UUIDv7 over UUIDv1 and
+6 if possible.
+""",
+)
+class UUID7(TransformPlugin):
+    """UUID7 Transform Plugin"""
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [str(uuid6.uuid7()) for _ in collection]
+        else:
+            result = [str(uuid6.uuid7())]
+        return result
+
+
+@Plugin(
+    label="UUID8",
+    categories=["Value", "Identifier"],
+    description="Generate a UUIDv8 from a random number, and the current time.",
+    documentation="""UUIDv8 features a time-ordered value field derived from the
+widely implemented and well known Unix Epoch timestamp source, the
+number of nanoseconds since midnight 1 Jan 1970 UTC, leap seconds
+excluded.
+""",
+)
+class UUID8(TransformPlugin):
+    """UUID8 Transform Plugin"""
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [str(uuid6.uuid8()) for _ in collection]
+        else:
+            result = [str(uuid6.uuid8())]
+        return result
+
+
+@Plugin(
+    label="UUID Convert",
+    categories=["Value", "Identifier"],
+    description="Convert a UUID string representation",
+    documentation="""Convert a UUID string with 32 hexadecimal digits to a 16-byte
+    string containing the six integer fields in big-endian byte order, a 16-byte string
+    the six integer fields in little-endian byte order, a 32-character lowercase
+    hexadecimal string, a 128-bit integer, or a URN. Strings in the correct format,
+    however, the log will show a warning if the input does not comply with the standard
+    specified in RFC 4122 and the proposed updates""",
+    parameters=[
+        PluginParameter(
+            param_type=uuid_convert_param_in,
+            name="from_format",
+            label="From",
+            description="Input string format",
+            default_value="uuid_hex",
+        ),
+        PluginParameter(
+            param_type=uuid_convert_param_out,
+            name="to_format",
+            label="To",
+            description="Output string format",
+            default_value="hex",
+        ),
+    ],
+)
+class UUIDConvert(TransformPlugin):
+    """Converts UUID representation"""
+
+    def __init__(self, from_format: str | None, to_format: str | None) -> None:
+        self.from_ = from_format
+        self.to_ = to_format
+
+    def uuid_validate(self, test_uuid: uuid.UUID, uuid_string: str) -> None:
+        """Warning if UUID string not standard (versions 1 to 8)"""
+        pattern = r"^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+
+        if not re.match(pattern, str(test_uuid)):
+            self.log.warning(
+                f"{uuid_string} is not a valid UUID as specified in RFC 4122 and "
+                f"the proposed updates"
+            )
+
+    def convert_uuid(self, uuid_string: str) -> str:  # noqa: PLR0912 C901
+        """Convert UUID string"""
+        if self.from_ == "uuid_hex":
+            try:
+                in_uuid = uuid.UUID(uuid_string)
+            except ValueError as exc:
+                raise ValueError(f"{uuid_string} is not a valid 32-bit UUID string") from exc
+
+        elif self.from_ == "int":
+            try:
+                in_uuid = uuid.UUID(int=int(uuid_string))
+            except ValueError as exc:
+                raise ValueError(
+                    f"{uuid_string} is not a valid 128-bit integer UUID value"
+                ) from exc
+
+        elif self.from_ == "urn":
+            if not uuid_string.lower().startswith("urn:uuid:"):
+                raise ValueError(f"{uuid_string} is not a valid UUID URN")
+
+            try:
+                in_uuid = uuid.UUID(uuid_string[9:])
+            except ValueError as exc:
+                raise ValueError(f"{uuid_string} is not a valid UUID URN") from exc
+
+        self.uuid_validate(in_uuid, uuid_string)
+
+        if self.to_ == "uuid":
+            result = str(in_uuid)
+        if self.to_ == "hex":
+            result = str(in_uuid.hex)
+        elif self.to_ == "int":
+            result = str(in_uuid.int)
+        elif self.to_ == "urn":
+            result = str(in_uuid.urn)
+        return result
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Trasnform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [self.convert_uuid(_) for _ in collection]
+        else:
+            raise ValueError("No input for UUID Convert")
+        return result
+
+
+@Plugin(
+    label="UUID Version",
+    categories=["Value", "Identifier"],
+    description="Outputs UUID version number of input",
+    documentation="""Input: UUID string, output: UUID version number of input.""",
+)
+class UUIDVersion(TransformPlugin):
+    """Outputs UUID version number"""
+
+    def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
+        """Transform"""
+        result = []
+        if len(inputs) != 0:
+            for collection in inputs:
+                result += [str(uuid.UUID(_).version) for _ in collection]
+        else:
+            raise ValueError("No input for UUID Version")
+        return result

cmem_plugin_uuid-1.0.0rc1/cmem_plugin_uuid/utils.py

@@ -0,0 +1,102 @@
+"""Utilities for cmem-plugin-uuid"""
+
+import uuid
+from binascii import unhexlify
+from collections import OrderedDict
+from hashlib import md5, sha1
+
+from cmem_plugin_base.dataintegration.parameter.choice import ChoiceParameterType
+
+uuid3_uuid5_namespace_param = ChoiceParameterType(
+    OrderedDict(
+        {
+            "namespace_url": "Namespace URL",
+            "namespace_dns": "Namespace DNS",
+            "namespace_oid": "Namespace OID",
+            "namespace_x500": "Namespace X500",
+            "": "",
+        }
+    ),
+)
+
+
+uuid3_uuid5_namespace_param.allow_only_autocompleted_values = False
+
+
+uuid_convert_param_in = ChoiceParameterType(
+    OrderedDict(
+        {
+            "uuid_hex": "UUID/32-char hexadecimal string",
+            "int": "128-bit integer",
+            "urn": "URN",
+        }
+    ),
+)
+
+uuid_convert_param_in.allow_only_autocompleted_values = True
+
+uuid_convert_param_out = ChoiceParameterType(
+    OrderedDict(
+        {
+            "uuid": "UUID",
+            "hex": "32-character lowercase hexadecimal string",
+            "int": "128-bit integer",
+            "urn": "URN",
+        }
+    ),
+)
+
+uuid_convert_param_out.allow_only_autocompleted_values = True
+
+
+def node_to_int(node: str) -> int:
+    """Convert a string representation of a node byte array to an integer"""
+    try:
+        byte_string = node.replace(":", "").replace("-", "")
+        byte_array = unhexlify(byte_string)
+        return int.from_bytes(byte_array, byteorder="big", signed=False)
+    except ValueError as exc:
+        raise ValueError(f"node: {exc} ({node})") from exc
+
+
+def clock_seq_to_int(clock_seq: str) -> int:
+    """Convert a string representation of a clock_seq to an integer."""
+    try:
+        return int(clock_seq)
+    except ValueError as exc:
+        raise ValueError(f"clock_seq: {exc} ({clock_seq})") from exc
+
+
+def namespace_hex(value: str, uuid_version: int) -> str | None:
+    """Return hex string from input value"""
+    hex_value = None
+    if uuid_version == 3:  # noqa: PLR2004
+        hex_value = md5(value.encode(), usedforsecurity=False).hexdigest()
+    elif uuid_version == 5:  # noqa: PLR2004
+        hex_value = sha1(value.encode(), usedforsecurity=False).hexdigest()[:32]
+    return hex_value
+
+
+def get_namespace_uuid(
+    namespace_as_uuid: bool | None,
+    namespace: str,
+    uuid_version: int,
+) -> uuid.UUID | None:
+    """Return namespace UUID"""
+    namespace_uuid = None
+
+    if namespace == "namespace_url":
+        namespace_uuid = uuid.NAMESPACE_URL
+    elif namespace == "namespace_dns":
+        namespace_uuid = uuid.NAMESPACE_DNS
+    elif namespace == "namespace_oid":
+        namespace_uuid = uuid.NAMESPACE_OID
+    elif namespace == "namespace_x500":
+        namespace_uuid = uuid.NAMESPACE_X500
+    elif namespace.strip():
+        if namespace_as_uuid:
+            namespace_uuid = uuid.UUID(namespace)
+        else:
+            namespace_uuid = uuid.UUID(hex=namespace_hex(namespace, uuid_version), version=1)
+
+    return namespace_uuid

cmem_plugin_uuid-1.0.0rc1/pyproject.toml

@@ -0,0 +1,82 @@
+[tool.poetry]
+name = "cmem-plugin-uuid"
+version = "1.0.0rc1"
+license = "Apache-2.0"
+description = "Create universally unique identifiers (UUIDs) versions 1, 3, 4, 5, 6, 7 and 8 in transformations."
+authors = ["eccenca GmbH <cmempy-developer@eccenca.com>"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Plugins",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+readme = "README-public.md"
+keywords = [
+    "eccenca Corporate Memory", "plugin", "UUID"
+]
+homepage = "https://github.com/eccenca/cmem-plugin-uuid"
+
+[tool.poetry.dependencies]
+# if you need to change python version here, change it also in .python-version
+python = "^3.11"
+uuid6 = ">=2023.5.2"
+
+[tool.poetry.dependencies.cmem-plugin-base]
+version = "^4.3.0"
+allow-prereleases = false
+
+[tool.poetry.group.dev.dependencies]
+genbadge = {extras = ["coverage"], version = "^1.1.1"}
+mypy = "^1.2.0"
+pip = ">=23.3" # Avoid safety issue 62044 for pip less than 23.3
+pytest = "^7.3.1"
+pytest-cov = "^4.1.0"
+pytest-dotenv = "^0.5.2"
+pytest-memray = { version = "^1.5.0",  markers = "platform_system != 'Windows'" }
+ruff = "^0.1.5"
+safety = "^1.10.3"
+
+[build-system]
+requires = ["poetry-core>=1.0.0","poetry-dynamic-versioning"]
+build-backend = "poetry_dynamic_versioning.backend"
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+dirty = true
+bump = true
+
+[tool.mypy]
+warn_return_any = true
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = ""
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.format]
+line-ending = "lf" # Use `\n` line endings for all files
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "ANN101",  # Missing type annotation for self in method
+    "ANN204",  # Missing return type annotation for special method `__init__`
+    "COM812",  # missing-trailing-comma
+    "D107",    # Missing docstring in __init__
+    "D203",    # [*] 1 blank line required before class docstring
+    "D211",    # No blank lines allowed before class docstring
+    "D213",    # Multi-line docstring summary should start at the second line
+    "D400",    # First line should end with a period
+    "D415",    # First line should end with a period, question mark, or exclamation point
+    "EM",      # Exception texts - https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
+    "FBT",     # The Boolean Trap - https://docs.astral.sh/ruff/rules/#flake8-boolean-trap-fbt
+    "FIX002",  # Allow to add TODO notes in the code
+    "G004",    # Logging statement uses f-string
+    "ISC001",  # single-line-implicit-string-concatenation
+    "PD",      # opinionated linting for pandas code
+    "S101",    # use of assert detected
+    "TRY003",  # Avoid specifying long messages outside the exception class
+]