digitalkin 0.3.2.dev22__tar.gz → 0.3.2.dev23__tar.gz

{digitalkin-0.3.2.dev22 → digitalkin-0.3.2.dev23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.3.2.dev22
+Version: 0.3.2.dev23
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International
@@ -437,18 +437,18 @@ License: Attribution-NonCommercial-ShareAlike 4.0 International
 Project-URL: Homepage, https://github.com/DigitalKin-ai/digitalkin
 Project-URL: Documentation, https://github.com/DigitalKin-ai/digitalkin
 Project-URL: Issues, https://github.com/DigitalKin-ai/digitalkin/issues
-Keywords: digitalkin,kin,agent,gprc,sdk
+Keywords: agent,digitalkin,gprc,kin,sdk
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE

digitalkin-0.3.2.dev23/pyproject.toml

@@ -0,0 +1,279 @@
+[build-system]
+requires      = ["setuptools >= 75.8.2", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+
+name            = "digitalkin"
+description     = "SDK to build kin used in DigitalKin"
+readme          = "README.md"
+requires-python = ">=3.10"
+license         = { file = "LICENSE" }
+
+keywords = ["agent", "digitalkin", "gprc", "kin", "sdk"]
+
+version = "0.3.2.dev23"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: Other/Proprietary License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python",
+    "Topic :: Software Development :: Libraries",
+]
+
+dependencies = [
+    "agentic-mesh-protocol==0.2.1.dev0",
+    "grpcio-health-checking>=1.76.0",
+    "grpcio-reflection>=1.76.0",
+    "grpcio-status>=1.76.0",
+    "pydantic>=2.12.5",
+    "surrealdb>=1.0.7",
+]
+
+    [project.optional-dependencies]
+    taskiq = [
+        "rstream>=0.40.0",
+        "taskiq-aio-pika>=0.5.0",
+        "taskiq-redis>=1.2.0",
+        "taskiq[reload]>=0.12.1",
+    ]
+
+    [project.urls]
+    Homepage      = "https://github.com/DigitalKin-ai/digitalkin"
+    Documentation = "https://github.com/DigitalKin-ai/digitalkin"
+    Issues        = "https://github.com/DigitalKin-ai/digitalkin/issues"
+
+    [[project.authors]]
+    name  = "DigitalKin.ai"
+    email = "contact@digitalkin.ai"
+
+[dependency-groups]
+dev = [
+    "build>=1.3.0",
+    "bump-my-version>=1.2.5",
+    "cryptography>=46.0.3",
+    "mypy>=1.19.1",
+    "pre-commit>=4.5.1",
+    "pyright>=1.1.407",
+    "ruff>=0.14.9",
+    "twine>=6.2.0",
+    "typos>=1.40.0",
+]
+tests = [
+    "freezegun>=1.5.5",
+    "grpcio-testing>=1.76.0",
+    "hdrhistogram>=0.10.3",
+    "psutil>=7.1.3",
+    "pytest-asyncio>=1.3.0",
+    "pytest-cov>=7.0.0",
+    "pytest-html==4.1.1",
+    "pytest-json-report==1.5.0",
+    "pytest-timeout>=2.4.0",
+    "pytest>=9.0.2",
+]
+docs = [
+    "griffe-inherited-docstrings>=1.1.2",
+    "markdown-callouts>=0.4.0",
+    "markdown-exec>=1.12.1",
+    "mike>=2.1.3",
+    "mkdocs-autorefs>=1.4.3",
+    "mkdocs-awesome-pages-plugin>=2.10.1",
+    "mkdocs-coverage>=2.0.0",
+    "mkdocs-git-committers-plugin-2>=2.5.0",
+    "mkdocs-git-revision-date-localized-plugin>=1.5.0",
+    "mkdocs-glightbox>=0.5.2",
+    "mkdocs-include-markdown-plugin>=7.2.0",
+    "mkdocs-literate-nav>=0.6.2",
+    "mkdocs-llmstxt>=0.5.0",
+    "mkdocs-material[imaging]>=9.7.0",
+    "mkdocs-minify-plugin>=0.8.0",
+    "mkdocs-open-in-new-tab>=1.0.8",
+    "mkdocs-redirects>=1.2.2",
+    "mkdocs-section-index>=0.3.10",
+    "mkdocs>=1.6.1",
+    "mkdocstrings-python>=2.0.1",
+    "mkdocstrings>=1.0.0",
+    "tomli>=2.3.0",
+]
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+    [tool.setuptools.packages.find]
+    where = ["examples", "src"]
+
+[tool.ruff]
+src            = ["src"]
+target-version = "py310"
+line-length    = 120
+indent-width   = 4
+show-fixes     = true
+unsafe-fixes   = true
+# Enable preview features.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "docs/*",
+    "examples/*",
+    "factory.py",
+    "generate_certificates.py",
+    "node_modules",
+    "tests/*",
+    "venv",
+]
+preview = true
+
+    [tool.ruff.lint]
+    select = [
+        "A",     # flake8-builtins
+        "ANN",   # flake8-annotations
+        "ARG",   # flake8-unused-arguments
+        "ASYNC", # flake8-async
+        "C4",    # flake8-comprehensions
+        "C90",   # mccabe (complex-structure)
+        "COM",   # flake8-commas
+        "D",     # pydocstyle
+        "DOC",   # pydoclint
+        "DTZ",   # flake8-datetimez
+        "E",     # pycodestyle-errors
+        "EM",    # flake8-errmsg
+        "ERA",   # eradicate
+        "F",     # pyflakes
+        "FBT",   # flake8-boolean-trap
+        "FLY",   # flynt
+        "FURB",  # Refurb
+        "G",     # flake8-logging-format
+        "I",     # isort
+        "ICN",   # flake8-import-conventions
+        "ISC",   # flake8-implicit-str-concat
+        "LOG",   # flake8-logging
+        "N",     # pep8-naming
+        "PERF",  # Perflint
+        "PIE",   # flake8-pie
+        "PL",    # Pylint
+        "PL",    # Pylint
+        "PT",    # flake8-pytest-style
+        "PYI",   # flake8-pyi
+        "Q",     # flake8-quotes
+        "RET",   # flake8-return
+        "RSE",   # flake8-raise
+        "RUF",   # Ruff-specific rules
+        "S",     # flake8-bandit
+        "SIM",   # flake8-simplify
+        "SLF",   # flake8-self
+        "T20",   # flake8-print
+        "TC",    # flake8-type-checking
+        "TRY",   # tryceratops
+        "UP",    # pyupgrade
+        "W",     # pycodestyle-warnings
+    ]
+
+    ignore = [
+        "COM812", # Disable because of formatter incompatibility
+        "DOC502", # Allow extraneous-exception in docstring
+        "S105",   # Hardcoded-password
+    ]
+
+    fixable = ["ALL"]
+
+        [tool.ruff.lint.pydocstyle]
+        convention = "google"
+
+        [tool.ruff.lint.per-file-ignores]
+        "tests/**/*.py" = [
+            "ANN001",
+            "ANN002",
+            "ANN003",
+            "ANN201",
+            "ANN401",
+            "ARG001",
+            "ARG002",
+            "C901",
+            "D100",
+            "D101",
+            "D102",
+            "D103",
+            "D107",
+            "D417",
+            "DOC201",
+            "DOC501",
+            "E501",
+            "ERA001",
+            "FBT001",
+            "FBT002",
+            "G004",
+            "N802",
+            "PERF203",
+            "PLC2701",
+            "PLR0911",
+            "PLR0912",
+            "PLR0914",
+            "PLR0915",
+            "PLR1702",
+            "PLR2004",
+            "PLR6301",
+            "S101",
+            "SLF001",
+            "TRY002",
+        ]
+
+        [tool.ruff.lint.pylint]
+        max-args = 10
+
+    [tool.ruff.format]
+    quote-style               = "double"
+    indent-style              = "space"
+    line-ending               = "auto"
+    docstring-code-format     = true
+    skip-magic-trailing-comma = false
+
+[tool.pyright]
+include = ["src"]
+exclude = ["**/.venv", "**/__pycache__"]
+
+[tool.mypy]
+exclude = ["examples", "tests"]
+
+[tool.pytest.ini_options]
+testpaths    = ["tests"]
+python_files = "test_*.py"
+asyncio_mode = "auto"
+
+log_cli   = false
+log_level = "ERROR"
+
+# Default timeout for tests (in seconds)
+timeout        = 10
+timeout_method = "signal" # More reliable for asyncio tests on Linux
+
+# Custom markers
+markers = [
+    "edge_case: marks tests for boundary conditions and edge cases",
+    "grpc: marks tests for gRPC service functionality",
+    "integration: marks tests that require real SurrealDB connection (deselect with '-m \"not integration\"')",
+    "regression: marks tests for previously fixed bugs",
+    "smoke: marks critical path tests that should always pass",
+    "validation: marks tests for input validation and schema checking",
+]

{digitalkin-0.3.2.dev22 → digitalkin-0.3.2.dev23}/src/digitalkin/__version__.py

@@ -5,4 +5,4 @@ from importlib.metadata import PackageNotFoundError, version
 try:
     __version__ = version("digitalkin")
 except PackageNotFoundError:
-    __version__ = "0.3.2.dev22"
+    __version__ = "0.3.2.dev23"

{digitalkin-0.3.2.dev22 → digitalkin-0.3.2.dev23}/src/digitalkin/models/module/__init__.py

@@ -14,7 +14,7 @@ from digitalkin.models.module.tool_cache import (
 )
 from digitalkin.models.module.tool_reference import (
     ToolReference,
-    ToolReferenceInput,
+    tool_reference_input,
 )
 from digitalkin.models.module.utility import (
     EndOfStreamOutput,
@@ -35,7 +35,7 @@ __all__ = [
     "ToolModuleInfo",
     "ToolParameter",
     "ToolReference",
-    "ToolReferenceInput",
     "UtilityProtocol",
     "UtilityRegistry",
+    "tool_reference_input",
 ]

digitalkin-0.3.2.dev23/src/digitalkin/models/module/tool_reference.py

@@ -0,0 +1,173 @@
+"""Tool reference types for module configuration."""
+
+from typing import Annotated
+
+from pydantic import AfterValidator, BaseModel, BeforeValidator, Field
+from pydantic.annotated_handlers import GetJsonSchemaHandler
+from pydantic.json_schema import JsonSchemaValue
+from pydantic_core import CoreSchema
+
+from digitalkin.models.module.tool_cache import (
+    SelectedTool,
+    ToolModuleInfo,
+    module_info_to_tool_module_info,
+)
+from digitalkin.services.communication.communication_strategy import CommunicationStrategy
+from digitalkin.services.registry import RegistryStrategy
+
+
+class ToolReference(BaseModel):
+    """Tool selection configuration and reference."""
+
+    selected_tools: list[SelectedTool] = Field(default=[], description="Tools selected by the user.")
+    setup_ids: list[str] = Field(default=[], description="Setup IDs for the user to choose from.")
+    module_ids: list[str] = Field(default=[], description="Module IDs for the user to choose from.")
+    tags: list[str] = Field(default=[], description="Tags for the user to choose from.")
+    max_tools: int = Field(default=0, description="Maximum tools to select. 0 for unlimited.")
+    min_tools: int = Field(default=0, description="Minimum tools to select. 0 for no minimum.")
+
+    async def resolve(self, registry: RegistryStrategy, communication: CommunicationStrategy) -> list[ToolModuleInfo]:
+        """Resolve this reference using the registry.
+
+        Args:
+            registry: Registry service for module discovery.
+            communication: Communication service for module schemas.
+
+        Returns:
+            List of ToolModuleInfo if resolved.
+        """
+        resolved: list[ToolModuleInfo] = []
+        for tool in self.selected_tools:
+            setup = registry.get_setup(tool.setup_id)
+            if setup and setup.module_id:
+                info = registry.discover_by_id(setup.module_id)
+                tool.slug = tool.setup_id
+                tool.module_id = setup.module_id
+                tool.name = setup.name
+                if info:
+                    resolved.append(await module_info_to_tool_module_info(info, tool, communication))
+
+        return resolved
+
+
+class _ToolReferenceInputSchema:
+    """Custom JSON schema generator with configurable maxItems and ui:options."""
+
+    def __init__(
+        self,
+        setup_ids: list[str],
+        module_ids: list[str],
+        tags: list[str],
+        max_tools: int = 0,
+        min_tools: int = 0,
+    ) -> None:
+        self.setup_ids = setup_ids
+        self.module_ids = module_ids
+        self.tags = tags
+        self.max_tools = max_tools
+        self.min_tools = min_tools
+
+    def __get_pydantic_json_schema__(  # noqa: PLW3201
+        self,
+        schema: CoreSchema,
+        handler: GetJsonSchemaHandler,
+    ) -> JsonSchemaValue:
+        """Generate JSON schema accepting both list[str] and ToolReference.
+
+        Args:
+            schema: The core schema from Pydantic.
+            handler: Handler to generate JSON schema from core schema.
+
+        Returns:
+            JSON schema with anyOf accepting array or ToolReference, plus ui:options.
+        """
+        json_schema = handler(schema)
+
+        array_option: dict[str, object] = {"type": "array", "items": {"type": "string"}}
+        if self.max_tools > 0 and self.max_tools >= self.min_tools:
+            array_option["maxItems"] = self.max_tools
+        if self.min_tools > 0 and self.min_tools <= self.max_tools:
+            array_option["minItems"] = self.min_tools
+
+        return {
+            "anyOf": [
+                array_option,
+                json_schema,
+            ],
+            "ui:options": {
+                "setup_ids": self.setup_ids,
+                "module_ids": self.module_ids,
+                "tags": self.tags,
+                "max_tools": self.max_tools,
+                "min_tools": self.min_tools,
+            },
+        }
+
+
+def tool_reference_input(
+    setup_ids: list[str] = [],
+    module_ids: list[str] = [],
+    tags: list[str] = [],
+    max_tools: int = 0,
+    min_tools: int = 0,
+) -> type[ToolReference]:
+    """Create ToolReferenceInput type with schema options and validation.
+
+    Args:
+        setup_ids: Setup IDs for the user to choose from.
+        module_ids: Module IDs for the user to choose from.
+        tags: Tags for the user to choose from.
+        max_tools: Maximum tools allowed. 0 for unlimited.
+        min_tools: Minimum tools required. 0 for no minimum.
+
+    Returns:
+        Annotated type for use in Pydantic models.
+    """
+
+    def convert_to_tool_reference(v: object) -> ToolReference | object:
+        """Convert list of setup IDs to ToolReference with config preserved.
+
+        Returns:
+            ToolReference if input is list, otherwise original value.
+        """
+        if isinstance(v, list):
+            return ToolReference(
+                selected_tools=[SelectedTool(setup_id=sid, slug=sid) for sid in v],
+                setup_ids=setup_ids,
+                module_ids=module_ids,
+                tags=tags,
+                max_tools=max_tools,
+                min_tools=min_tools,
+            )
+        return v
+
+    def validate_tools_count(v: ToolReference) -> ToolReference:
+        """Validate selected_tools count against min/max constraints.
+
+        Returns:
+            The validated ToolReference.
+
+        Raises:
+            ValueError: If count is below min_tools or above max_tools.
+        """
+        count = len(v.selected_tools)
+        if min_tools > 0 and count < min_tools:
+            msg = f"At least {min_tools} tools required, got {count}"
+            raise ValueError(msg)
+        if max_tools > 0 and count > max_tools:
+            msg = f"At most {max_tools} tools allowed, got {count}"
+            raise ValueError(msg)
+        return v
+
+    return Annotated[  # type: ignore[return-value]
+        ToolReference,
+        BeforeValidator(convert_to_tool_reference),
+        AfterValidator(validate_tools_count),
+        _ToolReferenceInputSchema(
+            setup_ids=setup_ids,
+            module_ids=module_ids,
+            tags=tags,
+            max_tools=max_tools,
+            min_tools=min_tools,
+        ),
+    ]

{digitalkin-0.3.2.dev22 → digitalkin-0.3.2.dev23}/src/digitalkin/utils/schema_splitter.py

@@ -30,7 +30,7 @@ class SchemaSplitter:
         return json_schema, ui_schema
 
     @classmethod
-    def _extract_ui_properties(
+    def _extract_ui_properties(  # noqa: C901, PLR0912
         cls,
         source: dict[str, Any],
         ui_target: dict[str, Any],
@@ -64,12 +64,11 @@ class SchemaSplitter:
                         cls._extract_ui_properties(item, ui_target, defs)
             elif key in {"if", "then", "else"} and isinstance(value, dict):
                 cls._extract_ui_properties(value, ui_target, defs)
-            elif key == "$ref" and isinstance(value, str) and defs is not None:
+            elif key == "$ref" and isinstance(value, str) and defs is not None and value.startswith("#/$defs/"):
                 # Resolve $ref and extract UI properties from the referenced definition
-                if value.startswith("#/$defs/"):
-                    def_name = value[8:]
-                    if def_name in defs:
-                        cls._extract_ui_properties(defs[def_name], ui_target, defs)
+                def_name = value[8:]
+                if def_name in defs:
+                    cls._extract_ui_properties(defs[def_name], ui_target, defs)
 
     @classmethod
     def _process_object(  # noqa: C901, PLR0912

{digitalkin-0.3.2.dev22 → digitalkin-0.3.2.dev23}/src/digitalkin.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.3.2.dev22
+Version: 0.3.2.dev23
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International
@@ -437,18 +437,18 @@ License: Attribution-NonCommercial-ShareAlike 4.0 International
 Project-URL: Homepage, https://github.com/DigitalKin-ai/digitalkin
 Project-URL: Documentation, https://github.com/DigitalKin-ai/digitalkin
 Project-URL: Issues, https://github.com/DigitalKin-ai/digitalkin/issues
-Keywords: digitalkin,kin,agent,gprc,sdk
+Keywords: agent,digitalkin,gprc,kin,sdk
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python
+Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE