IDKit 1.0.0__tar.gz

idkit-1.0.0/IDKit.egg-info/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: IDKit
+Version: 1.0.0
+Summary: A typed, dot-notation identifier system for Python 3.12+.
+Author: Ryan Kohl
+License-Expression: MIT
+Keywords: identifier,typing,enum,dsl
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# IDKit
+
+A small typed identifier system for Python 3.12+.
+
+It lets you build structured identifiers using dot notation:
+
+```python
+from idkit import ID
+
+identifier = ID.system.runtime.agent.analyzer
+
+print(identifier)
+# system::runtime-agent+analyzer
+
+print(identifier.namespace)
+# system::runtime-agent
+
+print(identifier.path)
+# system/runtime/agent/analyzer
+
+print(identifier.slug)
+# system-runtime-agent-analyzer
+```
+
+## Format
+
+```text
+Group::Source[-Component][+Role]
+```
+
+Examples:
+
+```text
+system::runtime
+system::runtime-agent
+system::runtime-agent+analyzer
+service::data-resource+ingester
+manage::workflow-pipeline+runner
+```
+
+## Type aliases
+
+```python
+from idkit import IDKitIdentifier, IDKitIdentifierLike, IDKitIdentifiable
+```
+
+Use `IDKitIdentifier` when you want the concrete implementation.
+
+Use `IDKitIdentifierLike` when your function only needs the public identifier interface.
+
+Use `IDKitIdentifiable` when your object exposes an `.identifier` property.
+
+Compatibility aliases are also exported:
+
+```python
+from idkit import AppIdentifier, AppIdentifierLike, AppIdentifiable
+```
+
+```python
+def register(identifier: IDKitIdentifierLike) -> None:
+    identifier.require_complete()
+    print(identifier.value)
+```
+
+## Installation
+
+```bash
+pip install idkit
+```
+
+## Parsing
+
+```python
+parsed = ID.parse("system::runtime-agent+analyzer")
+
+assert parsed == ID.system.runtime.agent.analyzer
+```
+
+## Matching
+
+```python
+identifier = ID.system.runtime.agent.analyzer
+
+identifier.matches(ID.system)
+# True
+
+identifier.matches(ID.system.runtime)
+# True
+
+identifier.matches(ID.system.runtime.agent)
+# True
+
+identifier.matches(ID.service)
+# False
+```
+
+## Parent traversal
+
+```python
+identifier = ID.system.runtime.agent.analyzer
+
+identifier.parent
+# Identifier('system::runtime-agent')
+
+identifier.parent.parent
+# Identifier('system::runtime')
+
+identifier.parent.parent.parent
+# Identifier('system')
+```
+
+## Development
+
+Run tests:
+
+```bash
+python3 -m pytest
+```

idkit-1.0.0/IDKit.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+pyproject.toml
+IDKit.egg-info/PKG-INFO
+IDKit.egg-info/SOURCES.txt
+IDKit.egg-info/dependency_links.txt
+IDKit.egg-info/top_level.txt
+idkit/__init__.py
+idkit/exceptions.py
+idkit/identifier.py
+idkit/idkit.py
+idkit/protocols.py
+idkit/py.typed
+idkit/root.py
+idkit/enums/__init__.py
+idkit/enums/group.py
+idkit/enums/operation.py
+idkit/enums/role.py
+idkit/enums/source.py
+tests/test_identifier.py

idkit-1.0.0/IDKit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

idkit-1.0.0/IDKit.egg-info/top_level.txt

@@ -0,0 +1 @@
+idkit

idkit-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Kohl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

idkit-1.0.0/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: IDKit
+Version: 1.0.0
+Summary: A typed, dot-notation identifier system for Python 3.12+.
+Author: Ryan Kohl
+License-Expression: MIT
+Keywords: identifier,typing,enum,dsl
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# IDKit
+
+A small typed identifier system for Python 3.12+.
+
+It lets you build structured identifiers using dot notation:
+
+```python
+from idkit import ID
+
+identifier = ID.system.runtime.agent.analyzer
+
+print(identifier)
+# system::runtime-agent+analyzer
+
+print(identifier.namespace)
+# system::runtime-agent
+
+print(identifier.path)
+# system/runtime/agent/analyzer
+
+print(identifier.slug)
+# system-runtime-agent-analyzer
+```
+
+## Format
+
+```text
+Group::Source[-Component][+Role]
+```
+
+Examples:
+
+```text
+system::runtime
+system::runtime-agent
+system::runtime-agent+analyzer
+service::data-resource+ingester
+manage::workflow-pipeline+runner
+```
+
+## Type aliases
+
+```python
+from idkit import IDKitIdentifier, IDKitIdentifierLike, IDKitIdentifiable
+```
+
+Use `IDKitIdentifier` when you want the concrete implementation.
+
+Use `IDKitIdentifierLike` when your function only needs the public identifier interface.
+
+Use `IDKitIdentifiable` when your object exposes an `.identifier` property.
+
+Compatibility aliases are also exported:
+
+```python
+from idkit import AppIdentifier, AppIdentifierLike, AppIdentifiable
+```
+
+```python
+def register(identifier: IDKitIdentifierLike) -> None:
+    identifier.require_complete()
+    print(identifier.value)
+```
+
+## Installation
+
+```bash
+pip install idkit
+```
+
+## Parsing
+
+```python
+parsed = ID.parse("system::runtime-agent+analyzer")
+
+assert parsed == ID.system.runtime.agent.analyzer
+```
+
+## Matching
+
+```python
+identifier = ID.system.runtime.agent.analyzer
+
+identifier.matches(ID.system)
+# True
+
+identifier.matches(ID.system.runtime)
+# True
+
+identifier.matches(ID.system.runtime.agent)
+# True
+
+identifier.matches(ID.service)
+# False
+```
+
+## Parent traversal
+
+```python
+identifier = ID.system.runtime.agent.analyzer
+
+identifier.parent
+# Identifier('system::runtime-agent')
+
+identifier.parent.parent
+# Identifier('system::runtime')
+
+identifier.parent.parent.parent
+# Identifier('system')
+```
+
+## Development
+
+Run tests:
+
+```bash
+python3 -m pytest
+```

idkit-1.0.0/README.md

@@ -0,0 +1,118 @@
+# IDKit
+
+A small typed identifier system for Python 3.12+.
+
+It lets you build structured identifiers using dot notation:
+
+```python
+from idkit import ID
+
+identifier = ID.system.runtime.agent.analyzer
+
+print(identifier)
+# system::runtime-agent+analyzer
+
+print(identifier.namespace)
+# system::runtime-agent
+
+print(identifier.path)
+# system/runtime/agent/analyzer
+
+print(identifier.slug)
+# system-runtime-agent-analyzer
+```
+
+## Format
+
+```text
+Group::Source[-Component][+Role]
+```
+
+Examples:
+
+```text
+system::runtime
+system::runtime-agent
+system::runtime-agent+analyzer
+service::data-resource+ingester
+manage::workflow-pipeline+runner
+```
+
+## Type aliases
+
+```python
+from idkit import IDKitIdentifier, IDKitIdentifierLike, IDKitIdentifiable
+```
+
+Use `IDKitIdentifier` when you want the concrete implementation.
+
+Use `IDKitIdentifierLike` when your function only needs the public identifier interface.
+
+Use `IDKitIdentifiable` when your object exposes an `.identifier` property.
+
+Compatibility aliases are also exported:
+
+```python
+from idkit import AppIdentifier, AppIdentifierLike, AppIdentifiable
+```
+
+```python
+def register(identifier: IDKitIdentifierLike) -> None:
+    identifier.require_complete()
+    print(identifier.value)
+```
+
+## Installation
+
+```bash
+pip install idkit
+```
+
+## Parsing
+
+```python
+parsed = ID.parse("system::runtime-agent+analyzer")
+
+assert parsed == ID.system.runtime.agent.analyzer
+```
+
+## Matching
+
+```python
+identifier = ID.system.runtime.agent.analyzer
+
+identifier.matches(ID.system)
+# True
+
+identifier.matches(ID.system.runtime)
+# True
+
+identifier.matches(ID.system.runtime.agent)
+# True
+
+identifier.matches(ID.service)
+# False
+```
+
+## Parent traversal
+
+```python
+identifier = ID.system.runtime.agent.analyzer
+
+identifier.parent
+# Identifier('system::runtime-agent')
+
+identifier.parent.parent
+# Identifier('system::runtime')
+
+identifier.parent.parent.parent
+# Identifier('system')
+```
+
+## Development
+
+Run tests:
+
+```bash
+python3 -m pytest
+```

idkit-1.0.0/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-1.0.0/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-1.0.0/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()