IDKit 1.0.0__py3-none-any.whl

idkit/__init__.py

@@ -0,0 +1,51 @@
+from .exceptions import (
+    IdentifierError,
+    IdentifierParseError,
+    IdentifierValidationError,
+)
+
+from .idkit import (
+    ID,
+    AppIdentifiable,
+    AppIdentifier,
+    AppIdentifierLike,
+    AppIdentifierRoot,
+    IDKitIdentifiable,
+    IDKitIdentifier,
+    IDKitIdentifierLike,
+    IDKitIdentifierRoot,
+    IDKitOperationIdentifier,
+    IdentifierGroup,
+    IdentifierSource,
+    IdentifierRole,
+    IdentifierOperation,
+)
+from .identifier import Identifier
+from .protocols import SupportsIdentifier, Identifiable
+from .root import IdentifierRoot, IDRoot
+
+
+__all__ = [
+    "ID",
+    "AppIdentifier",
+    "AppIdentifierRoot",
+    "AppIdentifierLike",
+    "AppIdentifiable",
+    "IdentifierGroup",
+    "IdentifierSource",
+    "IdentifierRole",
+    "IdentifierOperation",
+    "Identifier",
+    "IdentifierRoot",
+    "IDRoot",
+    "IDKitIdentifier",
+    "IDKitOperationIdentifier",
+    "IDKitIdentifierRoot",
+    "IDKitIdentifierLike",
+    "IDKitIdentifiable",
+    "SupportsIdentifier",
+    "Identifiable",
+    "IdentifierError",
+    "IdentifierParseError",
+    "IdentifierValidationError",
+]

idkit/enums/__init__.py

@@ -0,0 +1,12 @@
+from .group import IdentifierGroup
+from .source import IdentifierSource
+from .role import IdentifierRole
+from .operation import IdentifierOperation
+
+
+__all__ = [
+    "IdentifierGroup",
+    "IdentifierSource",
+    "IdentifierRole",
+    "IdentifierOperation",
+]

idkit/enums/group.py

@@ -0,0 +1,158 @@
+from enum import StrEnum, auto
+
+
+class IdentifierGroup(StrEnum):
+    """
+    The `Group` defines the primary classification or architectural domain of the `identifier` in the first segment. It represents the highest level of organization (e.g., `system`, `service`, `manage`).
+
+    Default namespace values used as the first segment of an identifier.
+
+    Group — Where does it belong?
+    Source — What is it?
+    Component — Which part of it?
+    Action — What does it do?
+    """
+
+    system = auto()
+    service = auto()
+    core = auto()
+    utility = auto()
+    library = auto()
+    package = auto()
+    module = auto()
+    framework = auto()
+    application = auto()
+    platform = auto()
+    runtime = auto()
+    database = auto()
+    storage = auto()
+    cache = auto()
+    network = auto()
+    transport = auto()
+    filesystem = auto()
+    cloud = auto()
+    cluster = auto()
+    node = auto()
+    host = auto()
+    container = auto()
+    source = auto()
+    stream = auto()
+    pipeline = auto()
+    warehouse = auto()
+    analytics = auto()
+    reporting = auto()
+    api = auto()
+    web = auto()
+    cli = auto()
+    shell = auto()
+    desktop = auto()
+    mobile = auto()
+    ui = auto()
+    domain = auto()
+    business = auto()
+    user = auto()
+    account = auto()
+    tenant = auto()
+    organization = auto()
+    project = auto()
+    workspace = auto()
+    workflow = auto()
+    scheduler = auto()
+    worker = auto()
+    job = auto()
+    queue = auto()
+    event = auto()
+    message = auto()
+    bot = auto()
+    agent = auto()
+    ai = auto()
+    testing = auto()
+    development = auto()
+    staging = auto()
+    production = auto()
+    build = auto()
+    deploy = auto()
+    migration = auto()
+    script = auto()
+
+
+class Architecture(StrEnum):
+    system = auto()
+    service = auto()
+    core = auto()
+    utility = auto()
+    library = auto()
+    package = auto()
+    module = auto()
+    framework = auto()
+    application = auto()
+    platform = auto()
+    runtime = auto()
+
+
+class Infrastructure(StrEnum):
+    database = auto()
+    storage = auto()
+    cache = auto()
+    network = auto()
+    transport = auto()
+    filesystem = auto()
+    cloud = auto()
+    cluster = auto()
+    node = auto()
+    host = auto()
+    container = auto()
+
+
+class Data(StrEnum):
+    source = auto()
+    stream = auto()
+    pipeline = auto()
+    warehouse = auto()
+    analytics = auto()
+    reporting = auto()
+
+
+class Interface(StrEnum):
+    api = auto()
+    web = auto()
+    cli = auto()
+    shell = auto()
+    desktop = auto()
+    mobile = auto()
+    ui = auto()
+
+
+class Business(StrEnum):
+    domain = auto()
+    business = auto()
+    user = auto()
+    account = auto()
+    tenant = auto()
+    organization = auto()
+    project = auto()
+    workspace = auto()
+
+
+class Automation(StrEnum):
+    workflow = auto()
+    scheduler = auto()
+    worker = auto()
+    job = auto()
+    queue = auto()
+    event = auto()
+    message = auto()
+    bot = auto()
+    agent = auto()
+    ai = auto()
+
+
+class Development(StrEnum):
+    testing = auto()
+    development = auto()
+    staging = auto()
+    production = auto()
+    build = auto()
+    deploy = auto()
+    migration = auto()
+    script = auto()

idkit/enums/operation.py

@@ -0,0 +1,135 @@
+from enum import StrEnum, auto
+
+
+class IdentifierOperation(StrEnum):
+    """
+    An operation describes what is being performed.
+
+    Operations are better for events, logs, tasks, states, and commands,
+    rather than stable object identity.
+    """
+
+    save = auto()
+    seed = auto()
+    sync = auto()
+    update = auto()
+    analyze = auto()
+    process = auto()
+    forward = auto()
+    ingest = auto()
+    extract = auto()
+    transform = auto()
+    execute = auto()
+    validate = auto()
+    control = auto()
+    run = auto()
+    use = auto()
+    filter = auto()
+    require = auto()
+    create = auto()
+    read = auto()
+    write = auto()
+    delete = auto()
+    load = auto()
+    parse = auto()
+    serialize = auto()
+    deserialize = auto()
+    compile = auto()
+    convert = auto()
+    publish = auto()
+    subscribe = auto()
+    dispatch = auto()
+    broadcast = auto()
+    send = auto()
+    receive = auto()
+    handle = auto()
+    listen = auto()
+    monitor = auto()
+    observe = auto()
+    watch = auto()
+    track = auto()
+    scan = auto()
+    search = auto()
+    index = auto()
+    discover = auto()
+    authenticate = auto()
+    authorize = auto()
+    verify = auto()
+    encrypt = auto()
+    decrypt = auto()
+    schedule = auto()
+    coordinate = auto()
+    orchestrate = auto()
+    adapt = auto()
+    connect = auto()
+    provide = auto()
+    resolve = auto()
+    route = auto()
+
+
+class Lifecycle(StrEnum):
+    create = auto()
+    delete = auto()
+    initialize = auto()
+    destroy = auto()
+
+
+class CURD(StrEnum):
+    read = auto()
+    write = auto()
+    update = auto()
+    save = auto()
+    patch = auto()
+    delete = auto()
+
+
+class Process(StrEnum):
+    analyze = auto()
+    process = auto()
+    transform = auto()
+    convert = auto()
+    compile = auto()
+    parse = auto()
+    serialize = auto()
+    deserialize = auto()
+
+
+class Validation(StrEnum):
+    validate = auto()
+    verify = auto()
+    authorize = auto()
+    authenticate = auto()
+    confirm = auto()
+
+
+class Communication(StrEnum):
+    send = auto()
+    receive = auto()
+    publish = auto()
+    subscribe = auto()
+    dispatch = auto()
+    broadcast = auto()
+    post = auto()
+
+
+class Discovery(StrEnum):
+    discover = auto()
+    scan = auto()
+    search = auto()
+    index = auto()
+    find = auto()
+
+
+class Monitoring(StrEnum):
+    monitor = auto()
+    observe = auto()
+    track = auto()
+    watch = auto()
+
+
+class Execution(StrEnum):
+    execute = auto()
+    run = auto()
+    invoke = auto()
+    trigger = auto()
+    start = auto()

idkit/enums/role.py

@@ -0,0 +1,85 @@
+from enum import StrEnum, auto
+
+
+class IdentifierRole(StrEnum):
+    """
+    A role describes what an identifier represents as a stable responsibility.
+
+    Examples:
+        analyzer
+        runner
+        ingester
+        validator
+        publisher
+
+    Best used in identifiers:
+        system::runtime-agent+analyzer
+        service::data-resource+ingester
+    """
+
+    saver = auto()
+    seeder = auto()
+    synchronizer = auto()
+    updater = auto()
+    analyzer = auto()
+    processor = auto()
+    forwarder = auto()
+    ingester = auto()
+    extractor = auto()
+    transformer = auto()
+    executor = auto()
+    validator = auto()
+    controller = auto()
+    runner = auto()
+    user = auto()
+    filterer = auto()
+    requirer = auto()
+
+    creator = auto()
+    reader = auto()
+    writer = auto()
+    deleter = auto()
+    loader = auto()
+    parser = auto()
+    serializer = auto()
+    deserializer = auto()
+    compiler = auto()
+    converter = auto()
+
+    publisher = auto()
+    subscriber = auto()
+    dispatcher = auto()
+    broadcaster = auto()
+    sender = auto()
+    receiver = auto()
+    handler = auto()
+    listener = auto()
+
+    monitor = auto()
+    observer = auto()
+    watcher = auto()
+    tracker = auto()
+    scanner = auto()
+    searcher = auto()
+    indexer = auto()
+    discoverer = auto()
+
+    authenticator = auto()
+    authorizer = auto()
+    verifier = auto()
+    encryptor = auto()
+    decryptor = auto()
+
+    scheduler = auto()
+    worker = auto()
+    coordinator = auto()
+    orchestrator = auto()
+    adapter = auto()
+    connector = auto()
+    provider = auto()
+    resolver = auto()
+    router = auto()
+    gateway = auto()
+    proxy = auto()
+    bridge = auto()
+    session = auto()

idkit/enums/source.py

@@ -0,0 +1,231 @@
+from enum import StrEnum, auto
+
+
+class IdentifierSource(StrEnum):
+    """
+    The `Source` identifies the primary object, resource, or subsystem that the `identifier` represents (e.g., `runtime`, `data`, `workflow`).
+
+    The optional `Component` further specializes the `Source` by identifying a specific part, implementation, or subcomponent (e.g., `agent`, `resource`, `pipeline`).
+
+    Default namespace values used in the middle segments of an identifier.
+
+    Group — Where does it belong?
+    Source — What is it?
+    Component — Which part of it?
+    Action — What does it do?
+    """
+
+    # resource = auto()
+    # manager = auto()
+    # collection = auto()
+    # bundle = auto()
+    # account = auto()
+    # profile = auto()
+    # setting = auto()
+    # config = auto()
+    # option = auto()
+    # data = auto()
+    # design = auto()
+    # script = auto()
+    # dataset = auto()
+    # record = auto()
+    # model = auto()
+    # workflow = auto()
+    # pipeline = auto()
+    # stack = auto()
+    # activity = auto()
+    # process = auto()
+    # controller = auto()
+    # context = auto()
+    # repository = auto()
+    # task = auto()
+    # event = auto()
+    # target = auto()
+    # state = auto()
+    # runtime = auto()
+    # mode = auto()
+    # token = auto()
+    # migration = auto()
+    # container = auto()
+    # payload = auto()
+    # engine = auto()
+    # agent = auto()
+    # signature = auto()
+    resource = auto()
+    manager = auto()
+    service = auto()
+    provider = auto()
+    factory = auto()
+    builder = auto()
+    repository = auto()
+    controller = auto()
+    handler = auto()
+    adapter = auto()
+    client = auto()
+    server = auto()
+    data = auto()
+    dataset = auto()
+    record = auto()
+    entity = auto()
+    model = auto()
+    schema = auto()
+    payload = auto()
+    document = auto()
+    collection = auto()
+    bundle = auto()
+    cache = auto()
+    snapshot = auto()
+    runtime = auto()
+    engine = auto()
+    process = auto()
+    task = auto()
+    thread = auto()
+    worker = auto()
+    job = auto()
+    queue = auto()
+    scheduler = auto()
+    context = auto()
+    state = auto()
+    session = auto()
+    config = auto()
+    setting = auto()
+    option = auto()
+    parameter = auto()
+    rule = auto()
+    profile = auto()
+    environment = auto()
+    connector = auto()
+    gateway = auto()
+    bridge = auto()
+    proxy = auto()
+    transport = auto()
+    channel = auto()
+    stream = auto()
+    agent = auto()
+    tool = auto()
+    prompt = auto()
+    memory = auto()
+    embedding = auto()
+    vector = auto()
+    knowledge = auto()
+    conversation = auto()
+    identity = auto()
+    credential = auto()
+    token = auto()
+    signature = auto()
+    certificate = auto()
+    permission = auto()
+    role = auto()
+    policy = auto()
+    secret = auto()
+    request = auto()
+    response = auto()
+    route = auto()
+    middleware = auto()
+    endpoint = auto()
+    page = auto()
+    view = auto()
+    template = auto()
+
+
+class CoreObjects(StrEnum):
+    resource = auto()
+    manager = auto()
+    service = auto()
+    provider = auto()
+    factory = auto()
+    builder = auto()
+    repository = auto()
+    controller = auto()
+    handler = auto()
+    adapter = auto()
+    client = auto()
+    server = auto()
+
+
+class Data(StrEnum):
+    data = auto()
+    dataset = auto()
+    record = auto()
+    entity = auto()
+    model = auto()
+    schema = auto()
+    payload = auto()
+    document = auto()
+    collection = auto()
+    bundle = auto()
+    cache = auto()
+    snapshot = auto()
+
+
+class Runtime(StrEnum):
+    runtime = auto()
+    engine = auto()
+    process = auto()
+    task = auto()
+    thread = auto()
+    worker = auto()
+    job = auto()
+    queue = auto()
+    scheduler = auto()
+    context = auto()
+    state = auto()
+    session = auto()
+
+
+class Configuration(StrEnum):
+    config = auto()
+    setting = auto()
+    option = auto()
+    parameter = auto()
+    policy = auto()
+    rule = auto()
+    profile = auto()
+    environment = auto()
+
+
+class Integration(StrEnum):
+    connector = auto()
+    gateway = auto()
+    bridge = auto()
+    proxy = auto()
+    transport = auto()
+    endpoint = auto()
+    channel = auto()
+    stream = auto()
+
+
+class AI(StrEnum):
+    agent = auto()
+    tool = auto()
+    prompt = auto()
+    memory = auto()
+    embedding = auto()
+    model = auto()
+    vector = auto()
+    knowledge = auto()
+    conversation = auto()
+
+
+class Security(StrEnum):
+    identity = auto()
+    credential = auto()
+    token = auto()
+    signature = auto()
+    certificate = auto()
+    permission = auto()
+    role = auto()
+    policy = auto()
+    secret = auto()
+
+
+class Web(StrEnum):
+    request = auto()
+    response = auto()
+    route = auto()
+    middleware = auto()
+    endpoint = auto()
+    resource = auto()
+    page = auto()
+    view = auto()
+    template = auto()

idkit/exceptions.py

@@ -0,0 +1,10 @@
+class IdentifierError(Exception):
+    """Base identifier exception."""
+
+
+class IdentifierParseError(IdentifierError, ValueError):
+    """Raised when an identifier cannot be parsed."""
+
+
+class IdentifierValidationError(IdentifierError, ValueError):
+    """Raised when an identifier fails validation."""