cuvis-ai-schemas 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

cuvis_ai_schemas/plugin/config.py

@@ -1,118 +1,118 @@
-"""Plugin configuration schemas."""
-
-from pathlib import Path
-
-from pydantic import BaseModel, ConfigDict, Field, field_validator
-
-
-class _BasePluginConfig(BaseModel):
-    """Base plugin configuration with strict validation.
-
-    All plugin types inherit from this base class to ensure
-    consistent validation and error handling.
-    """
-
-    model_config = ConfigDict(
-        extra="forbid",  # Reject unknown fields (catch typos)
-        validate_assignment=True,  # Validate on attribute assignment
-        populate_by_name=True,  # Allow field aliases
-    )
-
-    provides: list[str] = Field(
-        description="List of fully-qualified class paths this plugin provides",
-        min_length=1,  # At least one class required
-    )
-
-    @field_validator("provides")
-    @classmethod
-    def _validate_class_paths(cls, value: list[str]) -> list[str]:
-        """Ensure class paths are well-formed."""
-        for class_path in value:
-            if not class_path or "." not in class_path:
-                msg = (
-                    f"Invalid class path '{class_path}'. "
-                    "Must be fully-qualified (e.g., 'package.module.ClassName')"
-                )
-                raise ValueError(msg)
-        return value
-
-
-class GitPluginConfig(_BasePluginConfig):
-    """Git repository plugin configuration.
-
-    Supports:
-    - SSH URLs: git@gitlab.com:user/repo.git
-    - HTTPS URLs: https://github.com/user/repo.git
-    - Git tags only: v1.2.3, v0.1.0-alpha, etc.
-
-    Note: Branches and commit hashes are NOT supported for reproducibility.
-    """
-
-    repo: str = Field(
-        description="Git repository URL (SSH or HTTPS)",
-        min_length=1,
-    )
-
-    tag: str = Field(
-        description="Git tag (e.g., v1.2.3, v0.1.0-alpha). "
-        "Branches and commit hashes are not supported.",
-        min_length=1,
-    )
-
-    @field_validator("repo")
-    @classmethod
-    def _validate_repo_url(cls, value: str) -> str:
-        """Validate Git repository URL format."""
-        if not (
-            value.startswith("git@") or value.startswith("https://") or value.startswith("http://")
-        ):
-            msg = f"Invalid repo URL '{value}'. Must start with 'git@', 'https://', or 'http://'"
-            raise ValueError(msg)
-        return value
-
-    @field_validator("tag")
-    @classmethod
-    def _validate_tag(cls, value: str) -> str:
-        """Validate Git tag is not empty."""
-        if not value.strip():
-            msg = "Git tag cannot be empty"
-            raise ValueError(msg)
-        return value.strip()
-
-
-class LocalPluginConfig(_BasePluginConfig):
-    """Local filesystem plugin configuration.
-
-    Supports:
-    - Absolute paths: /home/user/my-plugin
-    - Relative paths: ../my-plugin (resolved relative to manifest file)
-    - Windows paths: C:\\Users\\user\\my-plugin
-    """
-
-    path: str = Field(
-        description="Absolute or relative path to plugin directory",
-        min_length=1,
-    )
-
-    @field_validator("path")
-    @classmethod
-    def _validate_path(cls, value: str) -> str:
-        """Validate path is not empty."""
-        if not value.strip():
-            msg = "Path cannot be empty"
-            raise ValueError(msg)
-        return value.strip()
-
-    def resolve_path(self, manifest_dir: Path) -> Path:
-        """Resolve relative paths to absolute paths.
-
-        Args:
-            manifest_dir: Directory containing the manifest file
-
-        Returns:
-            Absolute path to plugin directory
-        """
-        plugin_path = Path(self.path)
-        if not plugin_path.is_absolute():
-            plugin_path = (manifest_dir / plugin_path).resolve()
-        return plugin_path
+"""Plugin configuration schemas."""
+
+from pathlib import Path
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+
+class _BasePluginConfig(BaseModel):
+    """Base plugin configuration with strict validation.
+
+    All plugin types inherit from this base class to ensure
+    consistent validation and error handling.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",  # Reject unknown fields (catch typos)
+        validate_assignment=True,  # Validate on attribute assignment
+        populate_by_name=True,  # Allow field aliases
+    )
+
+    provides: list[str] = Field(
+        description="List of fully-qualified class paths this plugin provides",
+        min_length=1,  # At least one class required
+    )
+
+    @field_validator("provides")
+    @classmethod
+    def _validate_class_paths(cls, value: list[str]) -> list[str]:
+        """Ensure class paths are well-formed."""
+        for class_path in value:
+            if not class_path or "." not in class_path:
+                msg = (
+                    f"Invalid class path '{class_path}'. "
+                    "Must be fully-qualified (e.g., 'package.module.ClassName')"
+                )
+                raise ValueError(msg)
+        return value
+
+
+class GitPluginConfig(_BasePluginConfig):
+    """Git repository plugin configuration.
+
+    Supports:
+    - SSH URLs: git@gitlab.com:user/repo.git
+    - HTTPS URLs: https://github.com/user/repo.git
+    - Git tags only: v1.2.3, v0.1.0-alpha, etc.
+
+    Note: Branches and commit hashes are NOT supported for reproducibility.
+    """
+
+    repo: str = Field(
+        description="Git repository URL (SSH or HTTPS)",
+        min_length=1,
+    )
+
+    tag: str = Field(
+        description="Git tag (e.g., v1.2.3, v0.1.0-alpha). "
+        "Branches and commit hashes are not supported.",
+        min_length=1,
+    )
+
+    @field_validator("repo")
+    @classmethod
+    def _validate_repo_url(cls, value: str) -> str:
+        """Validate Git repository URL format."""
+        if not (
+            value.startswith("git@") or value.startswith("https://") or value.startswith("http://")
+        ):
+            msg = f"Invalid repo URL '{value}'. Must start with 'git@', 'https://', or 'http://'"
+            raise ValueError(msg)
+        return value
+
+    @field_validator("tag")
+    @classmethod
+    def _validate_tag(cls, value: str) -> str:
+        """Validate Git tag is not empty."""
+        if not value.strip():
+            msg = "Git tag cannot be empty"
+            raise ValueError(msg)
+        return value.strip()
+
+
+class LocalPluginConfig(_BasePluginConfig):
+    """Local filesystem plugin configuration.
+
+    Supports:
+    - Absolute paths: /home/user/my-plugin
+    - Relative paths: ../my-plugin (resolved relative to manifest file)
+    - Windows paths: C:\\Users\\user\\my-plugin
+    """
+
+    path: str = Field(
+        description="Absolute or relative path to plugin directory",
+        min_length=1,
+    )
+
+    @field_validator("path")
+    @classmethod
+    def _validate_path(cls, value: str) -> str:
+        """Validate path is not empty."""
+        if not value.strip():
+            msg = "Path cannot be empty"
+            raise ValueError(msg)
+        return value.strip()
+
+    def resolve_path(self, manifest_dir: Path) -> Path:
+        """Resolve relative paths to absolute paths.
+
+        Args:
+            manifest_dir: Directory containing the manifest file
+
+        Returns:
+            Absolute path to plugin directory
+        """
+        plugin_path = Path(self.path)
+        if not plugin_path.is_absolute():
+            plugin_path = (manifest_dir / plugin_path).resolve()
+        return plugin_path

cuvis_ai_schemas/plugin/manifest.py

@@ -1,95 +1,95 @@
-"""Plugin manifest schema."""
-
-from pathlib import Path
-from typing import Annotated
-
-import yaml
-from pydantic import BaseModel, ConfigDict, Field, field_validator
-
-from cuvis_ai_schemas.plugin.config import GitPluginConfig, LocalPluginConfig
-
-
-class PluginManifest(BaseModel):
-    """Complete plugin manifest containing all plugin configurations.
-
-    This is the root configuration object validated when loading
-    a plugins.yaml file or dictionary.
-    """
-
-    model_config = ConfigDict(
-        extra="forbid",
-        validate_assignment=True,
-    )
-
-    plugins: dict[
-        str,
-        Annotated[
-            GitPluginConfig | LocalPluginConfig,
-            Field(discriminator=None),  # Pydantic will auto-detect based on fields
-        ],
-    ] = Field(
-        description="Map of plugin names to their configurations",
-        default_factory=dict,
-    )
-
-    @field_validator("plugins")
-    @classmethod
-    def _validate_plugin_names(cls, value: dict) -> dict:
-        """Ensure plugin names are valid Python identifiers."""
-        for name in value.keys():
-            if not name.isidentifier():
-                msg = f"Invalid plugin name '{name}'. Must be a valid Python identifier"
-                raise ValueError(msg)
-        return value
-
-    @classmethod
-    def from_yaml(cls, yaml_path: Path) -> "PluginManifest":
-        """Load and validate manifest from YAML file.
-
-        Args:
-            yaml_path: Path to YAML file
-
-        Returns:
-            Validated PluginManifest instance
-
-        Raises:
-            FileNotFoundError: If yaml_path doesn't exist
-        """
-        if not yaml_path.exists():
-            msg = f"Plugin manifest not found: {yaml_path}"
-            raise FileNotFoundError(msg)
-
-        with yaml_path.open("r", encoding="utf-8") as f:
-            data = yaml.safe_load(f)
-
-        if not data:
-            return cls(plugins={})
-
-        return cls.model_validate(data)
-
-    @classmethod
-    def from_dict(cls, data: dict) -> "PluginManifest":
-        """Load and validate manifest from dictionary.
-
-        Args:
-            data: Dictionary containing plugin configurations
-
-        Returns:
-            Validated PluginManifest instance
-        """
-        return cls.model_validate(data)
-
-    def to_yaml(self, yaml_path: Path) -> None:
-        """Save manifest to YAML file.
-
-        Args:
-            yaml_path: Path where YAML file should be saved
-        """
-        yaml_path.parent.mkdir(parents=True, exist_ok=True)
-        with yaml_path.open("w", encoding="utf-8") as f:
-            yaml.safe_dump(
-                self.model_dump(exclude_none=True),
-                f,
-                sort_keys=False,
-                default_flow_style=False,
-            )
+"""Plugin manifest schema."""
+
+from pathlib import Path
+from typing import Annotated
+
+import yaml
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+from cuvis_ai_schemas.plugin.config import GitPluginConfig, LocalPluginConfig
+
+
+class PluginManifest(BaseModel):
+    """Complete plugin manifest containing all plugin configurations.
+
+    This is the root configuration object validated when loading
+    a plugins.yaml file or dictionary.
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        validate_assignment=True,
+    )
+
+    plugins: dict[
+        str,
+        Annotated[
+            GitPluginConfig | LocalPluginConfig,
+            Field(discriminator=None),  # Pydantic will auto-detect based on fields
+        ],
+    ] = Field(
+        description="Map of plugin names to their configurations",
+        default_factory=dict,
+    )
+
+    @field_validator("plugins")
+    @classmethod
+    def _validate_plugin_names(cls, value: dict) -> dict:
+        """Ensure plugin names are valid Python identifiers."""
+        for name in value.keys():
+            if not name.isidentifier():
+                msg = f"Invalid plugin name '{name}'. Must be a valid Python identifier"
+                raise ValueError(msg)
+        return value
+
+    @classmethod
+    def from_yaml(cls, yaml_path: Path) -> "PluginManifest":
+        """Load and validate manifest from YAML file.
+
+        Args:
+            yaml_path: Path to YAML file
+
+        Returns:
+            Validated PluginManifest instance
+
+        Raises:
+            FileNotFoundError: If yaml_path doesn't exist
+        """
+        if not yaml_path.exists():
+            msg = f"Plugin manifest not found: {yaml_path}"
+            raise FileNotFoundError(msg)
+
+        with yaml_path.open("r", encoding="utf-8") as f:
+            data = yaml.safe_load(f)
+
+        if not data:
+            return cls(plugins={})
+
+        return cls.model_validate(data)
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "PluginManifest":
+        """Load and validate manifest from dictionary.
+
+        Args:
+            data: Dictionary containing plugin configurations
+
+        Returns:
+            Validated PluginManifest instance
+        """
+        return cls.model_validate(data)
+
+    def to_yaml(self, yaml_path: Path) -> None:
+        """Save manifest to YAML file.
+
+        Args:
+            yaml_path: Path where YAML file should be saved
+        """
+        yaml_path.parent.mkdir(parents=True, exist_ok=True)
+        with yaml_path.open("w", encoding="utf-8") as f:
+            yaml.safe_dump(
+                self.model_dump(exclude_none=True),
+                f,
+                sort_keys=False,
+                default_flow_style=False,
+            )

{cuvis_ai_schemas-0.1.0.dist-info → cuvis_ai_schemas-0.1.2.dist-info}/METADATA

@@ -1,111 +1,111 @@
-Metadata-Version: 2.4
-Name: cuvis-ai-schemas
-Version: 0.1.0
-Summary: Lightweight schema definitions for cuvis-ai ecosystem
-Author-email: "Cubert GmbH, Ulm, Germany" <SDK@cubert-gmbh.com>
-License: Apache-2.0
-Project-URL: Homepage, https://www.cubert-hyperspectral.com/
-Project-URL: Repository, https://github.com/cubert-hyperspectral/cuvis-ai-schemas
-Project-URL: Documentation, https://cubert-hyperspectral.github.io/cuvis-ai-schemas/
-Project-URL: Issues, https://github.com/cubert-hyperspectral/cuvis-ai-schemas/issues
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: <3.12,>=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: pydantic<3.0.0,>=2.0.0
-Requires-Dist: pyyaml>=6.0
-Provides-Extra: proto
-Requires-Dist: grpcio>=1.56.0; extra == "proto"
-Requires-Dist: protobuf>=4.25.0; extra == "proto"
-Requires-Dist: grpcio-tools>=1.56.0; extra == "proto"
-Provides-Extra: torch
-Requires-Dist: torch>=2.0.0; extra == "torch"
-Requires-Dist: torchvision; extra == "torch"
-Provides-Extra: numpy
-Requires-Dist: numpy>=1.21.0; extra == "numpy"
-Provides-Extra: lightning
-Requires-Dist: pytorch-lightning>=2.0.0; extra == "lightning"
-Provides-Extra: full
-Requires-Dist: cuvis-ai-schemas[lightning,numpy,proto,torch]; extra == "full"
-Provides-Extra: dev
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: pytest>=7.0.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
-Requires-Dist: mypy>=1.8.0; extra == "dev"
-Requires-Dist: types-protobuf; extra == "dev"
-Requires-Dist: types-grpcio; extra == "dev"
-Requires-Dist: types-PyYAML; extra == "dev"
-Requires-Dist: interrogate>=1.7.0; extra == "dev"
-Dynamic: license-file
-
-# cuvis-ai-schemas
-
-Lightweight schema definitions for the cuvis-ai ecosystem.
-
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
-[![Python](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/)
-
-## Overview
-
-`cuvis-ai-schemas` is a centralized, dependency-light package of schema definitions used across the cuvis-ai ecosystem. It enables type-safe communication between services without heavy runtime requirements.
-
-Key points:
-- Minimal deps (pydantic + pyyaml)
-- Full Pydantic validation
-- Optional extras for proto, torch, numpy, lightning
-
-## Installation
-
-```bash
-uv add cuvis-ai-schemas
-uv add "cuvis-ai-schemas[proto]"
-uv add "cuvis-ai-schemas[full]"
-```
-
-Extras:
-- `proto`: gRPC and protobuf support
-- `torch`: PyTorch dtype handling (validation only)
-- `numpy`: NumPy array support
-- `lightning`: PyTorch Lightning training configs
-- `full`: All features
-- `dev`: Development dependencies
-
-## Usage
-
-```python
-from cuvis_ai_schemas.pipeline import PipelineConfig, NodeConfig
-
-pipeline = PipelineConfig(
-    nodes=[NodeConfig(id="node_1", class_name="DataLoader", params={"batch_size": 32})],
-    connections=[],
-)
-
-pipeline_json = pipeline.to_json()
-pipeline = PipelineConfig.from_json(pipeline_json)
-```
-
-## Development
-
-```bash
-uv sync --extra dev
-uv run pytest tests/ -v
-uv run ruff check cuvis_ai_schemas/ tests/
-uv run ruff format cuvis_ai_schemas/ tests/
-uv run mypy cuvis_ai_schemas/
-```
-
-## Contributing
-
-Contributions are welcome. Please:
-1. Ensure tests pass
-2. Run ruff format and ruff check
-3. Keep type hints and update docs as needed
-
-## License
-
-Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
+Metadata-Version: 2.4
+Name: cuvis-ai-schemas
+Version: 0.1.2
+Summary: Lightweight schema definitions for cuvis-ai ecosystem
+Author-email: "Cubert GmbH, Ulm, Germany" <SDK@cubert-gmbh.com>
+License: Apache-2.0
+Project-URL: Homepage, https://www.cubert-hyperspectral.com/
+Project-URL: Repository, https://github.com/cubert-hyperspectral/cuvis-ai-schemas
+Project-URL: Documentation, https://cubert-hyperspectral.github.io/cuvis-ai-schemas/
+Project-URL: Issues, https://github.com/cubert-hyperspectral/cuvis-ai-schemas/issues
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.12,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: proto
+Requires-Dist: grpcio>=1.56.0; extra == "proto"
+Requires-Dist: protobuf>=4.25.0; extra == "proto"
+Requires-Dist: grpcio-tools>=1.56.0; extra == "proto"
+Provides-Extra: torch
+Requires-Dist: torch>=2.0.0; extra == "torch"
+Requires-Dist: torchvision; extra == "torch"
+Provides-Extra: numpy
+Requires-Dist: numpy>=1.21.0; extra == "numpy"
+Provides-Extra: lightning
+Requires-Dist: pytorch-lightning>=2.0.0; extra == "lightning"
+Provides-Extra: full
+Requires-Dist: cuvis-ai-schemas[lightning,numpy,proto,torch]; extra == "full"
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: types-protobuf; extra == "dev"
+Requires-Dist: types-grpcio; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: interrogate>=1.7.0; extra == "dev"
+Dynamic: license-file
+
+# cuvis-ai-schemas
+
+Lightweight schema definitions for the cuvis-ai ecosystem.
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/)
+
+## Overview
+
+`cuvis-ai-schemas` is a centralized, dependency-light package of schema definitions used across the cuvis-ai ecosystem. It enables type-safe communication between services without heavy runtime requirements.
+
+Key points:
+- Minimal deps (pydantic + pyyaml)
+- Full Pydantic validation
+- Optional extras for proto, torch, numpy, lightning
+
+## Installation
+
+```bash
+uv add cuvis-ai-schemas
+uv add "cuvis-ai-schemas[proto]"
+uv add "cuvis-ai-schemas[full]"
+```
+
+Extras:
+- `proto`: gRPC and protobuf support
+- `torch`: PyTorch dtype handling (validation only)
+- `numpy`: NumPy array support
+- `lightning`: PyTorch Lightning training configs
+- `full`: All features
+- `dev`: Development dependencies
+
+## Usage
+
+```python
+from cuvis_ai_schemas.pipeline import PipelineConfig, NodeConfig
+
+pipeline = PipelineConfig(
+    nodes=[NodeConfig(id="node_1", class_name="DataLoader", params={"batch_size": 32})],
+    connections=[],
+)
+
+pipeline_json = pipeline.to_json()
+pipeline = PipelineConfig.from_json(pipeline_json)
+```
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest tests/ -v
+uv run ruff check cuvis_ai_schemas/ tests/
+uv run ruff format cuvis_ai_schemas/ tests/
+uv run mypy cuvis_ai_schemas/
+```
+
+## Contributing
+
+Contributions are welcome. Please:
+1. Ensure tests pass
+2. Run ruff format and ruff check
+3. Keep type hints and update docs as needed
+
+## License
+
+Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.