UUID Generator

Generate UUID versions 1, 3, 4, 5, 6, 7, and 8. Format the result (case, separator, length, prefix, suffix), or draw a custom alphabet when a standard UUID is not what you need. The command can also print each UUID as URL-safe Base64 or as an MD5 digest.

The PyPI name is lupaxa-uuid-generator. The import path is lupaxa.uuid_generator. The console script is uuid-generator. lupaxa is a namespace package — there is no lupaxa/__init__.py.

Public names: UUIDGenerator, UUIDGeneratorError, __version__, get_version().

Install

pip install lupaxa-uuid-generator

Requires Python 3.10+. There are no runtime dependencies.

Versions

Versions 3 and 5 use the DNS namespace and the name example.com. Versions 1 and 6 share the placeholder node 00:11:22:33:44:55. Version 8 is a=0x12345678, b=0x9abcdef0, c=0x11223344. Versions 4 and 7 are single samples. Another call will differ.

Library

generate_uuid takes one config mapping and can format the result. create_uuid takes arguments and returns the raw UUID. Version 8 blocks are a, b, and c either way, the same values as uuid.uuid8(a, b, c).

Generate UUID

import uuid

from lupaxa.uuid_generator import UUIDGenerator

UUIDGenerator.generate_uuid()
UUIDGenerator.generate_uuid({"version": 1})
UUIDGenerator.generate_uuid({"version": 6})
UUIDGenerator.generate_uuid({"version": 7})
UUIDGenerator.generate_uuid(
    {"version": 8, "a": 0x12345678, "b": 0x9ABCDEF0, "c": 0x11223344}
)
UUIDGenerator.generate_uuid(
    {
        "version": 5,
        "namespace": uuid.NAMESPACE_DNS,
        "name": "example.com",
        "format_type": "uppercase",
        "prefix": "id-",
    }
)

Create UUID

import uuid

from lupaxa.uuid_generator import UUIDGenerator

UUIDGenerator.create_uuid()
UUIDGenerator.create_uuid(1)
UUIDGenerator.create_uuid(3, uuid.NAMESPACE_DNS, "example.com")
UUIDGenerator.create_uuid(5, uuid.NAMESPACE_DNS, "example.com")
UUIDGenerator.create_uuid(6)
UUIDGenerator.create_uuid(7)
UUIDGenerator.create_uuid(8, a=0x12345678, b=0x9ABCDEF0, c=0x11223344)

Version 6 reorders the version 1 timestamp so values sort, and keeps that same clock sequence and node. Version 7 needs no namespace. Its first 48 bits are Unix time in milliseconds, so values from one process sort by creation time. Version 8 uses the same a, b, and c blocks as uuid.uuid8: 48, 12, and 62 bits. Wider integers keep their low bits. An omitted block is filled at random.

apply_format and add_prefix_suffix are the steps generate_uuid runs after create_uuid. encode_uuid and decode_uuid use URL-safe Base64. hash_uuid accepts sha256 (default) or md5. generate_unique_uuid retries until the value is absent from the list you pass.

from lupaxa.uuid_generator import UUIDGenerator, UUIDGeneratorError

try:
    UUIDGenerator.generate_uuid({"version": 5})
except UUIDGeneratorError as exc:
    print(exc)

UUIDGeneratorError is a ValueError.

CLI

uuid-generator
uuid-generator -n 3
uuid-generator --uuid-version 1
uuid-generator --uuid-version 6
uuid-generator --uuid-version 7
uuid-generator --uuid-version 8 --a 0x12345678 --b 0x9abcdef0 --c 0x11223344
uuid-generator --base64
uuid-generator --md5
uuid-generator --base64 --md5
uuid-generator --uuid-version 5 --namespace dns --name example.com
uuid-generator --format no-dashes --prefix id-
uuid-generator --version

One identifier is printed per line. The default is a single version 4 UUID.

--base64 and --md5 both describe the identifier that would have been printed. Together they print the Base64 form, a space, then the MD5 digest. --base64 needs a value uuid.UUID can parse, so a prefix, suffix, custom separator, or shortened length exits 2. Custom alphabets stay on the library.

Development

make init
make python-install-dev
make python-check