Skip to content

Commit

Permalink
edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
muddymudskipper committed Jan 31, 2024
1 parent 83558c0 commit 4904533
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 21 deletions.
9 changes: 3 additions & 6 deletions README-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Create universally unique identifiers (UUIDs) versions 1, 3, 4, 5, 6, 7 and 8 in transformations.

[![eccenca Corporate Memory](https://img.shields.io/badge/eccenca-Corporate%20Memory-orange)](https://documentation.eccenca.com) [![workflow](https://github.com/eccenca/cmem-plugin-uuid/actions/workflows/check.yml/badge.svg)](https://github.com/eccenca/cmem-plugin-uuid/actions) [![pypi version](https://img.shields.io/pypi/v/cmem-plugin-uuid)](https://pypi.org/project/uuid) [![license](https://img.shields.io/pypi/l/cmem-plugin-uuid)](https://pypi.org/project/cmem-plugin-uuid)
## Installation

`cmemc -c my-cmem admin workspace python install cmem-plugin-uuid`

## UUID1

Expand Down Expand Up @@ -50,8 +52,6 @@ If none of the predefined namespace UUIDs is selected, the input namespace is ei
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`

Expand Down Expand Up @@ -104,8 +104,6 @@ interpreted as a UUID, or used to derive a UUID (see parameter _Namespace as UUI
Default value: _none_
ID: `namespace`



#### Namespace as UUID

Applies only if none of the pre-defined namespaces is selected. If enabled, the namespace string
Expand Down Expand Up @@ -200,7 +198,6 @@ Options:
Default value: _UUID/32-character lowercase hexadecimal string_
ID: `from_format`


#### To

The output format
Expand Down
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ Create universally unique identifiers (UUIDs) versions 1, 3, 4, 5, 6, 7 and 8 in

[![eccenca Corporate Memory](https://img.shields.io/badge/eccenca-Corporate%20Memory-orange)](https://documentation.eccenca.com) [![workflow](https://github.com/eccenca/cmem-plugin-uuid/actions/workflows/check.yml/badge.svg)](https://github.com/eccenca/cmem-plugin-uuid/actions) [![pypi version](https://img.shields.io/pypi/v/cmem-plugin-uuid)](https://pypi.org/project/uuid) [![license](https://img.shields.io/pypi/l/cmem-plugin-uuid)](https://pypi.org/project/cmem-plugin-uuid)

## Installation

`cmemc -c my-cmem admin workspace python install cmem-plugin-uuid`

## Development

- Run [task](https://taskfile.dev/) to see all major development tasks.
- 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).

## UUID1

UUID1 version is generated from a host ID, sequence number, and the current time.
Expand Down Expand Up @@ -50,8 +60,6 @@ If none of the predefined namespace UUIDs is selected, the input namespace is ei
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`

Expand Down Expand Up @@ -104,8 +112,6 @@ interpreted as a UUID, or used to derive a UUID (see parameter _Namespace as UUI
Default value: _none_
ID: `namespace`



#### Namespace as UUID

Applies only if none of the pre-defined namespaces is selected. If enabled, the namespace string
Expand Down Expand Up @@ -200,7 +206,6 @@ Options:
Default value: _UUID/32-character lowercase hexadecimal string_
ID: `from_format`


#### To

The output format
Expand All @@ -222,12 +227,3 @@ Options:

Default value: _32-character lowercase hexadecimal string_
ID: `to_format`

<br>

## Development

- Run [task](https://taskfile.dev/) to see all major development tasks.
- 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).

2 changes: 1 addition & 1 deletion cmem_plugin_uuid/transform/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ def transform(self, inputs: Sequence[Sequence[str]]) -> Sequence[str]:
try:
result += [str(uuid6.uuid1_to_uuid6(uuid.UUID(_)))]
except ValueError as exc:
raise ValueError(f"{_} is not a valid UUIDv1 string") from exc
raise ValueError(f"{_} is not a valid UUIDv1 string") from exc
else:
raise ValueError("No input for UUID1 to UUID6")
return result
Expand Down

0 comments on commit 4904533

Please sign in to comment.