ods-models-py 0.1.0__tar.gz

ods_models_py-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: ods-models-py
+Version: 0.1.0
+Summary: Pydantic data models for ODS (Optikka Design System) - Python implementation
+Author-email: Optikka <dev@optikka.com>
+License: PROPRIETARY
+Project-URL: Homepage, https://github.com/optikka/ods
+Project-URL: Repository, https://github.com/optikka/ods
+Keywords: ods,models,pydantic,renderer,optikka
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic<3.0.0,>=2.6.1
+Requires-Dist: ods-types-py<1.0.0,>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+
+# ods-models-py
+
+Pydantic data models for the ODS (Optikka Design System) - Python implementation.
+
+This is the Python equivalent of the `@optikka/ods-models` npm package, providing Pydantic models for templates, inputs, render runs, and related entities.
+
+## Installation
+
+```bash
+pip install ods-models-py
+```
+
+## Usage
+
+```python
+from ods_models import (
+    TemplateRegistry,
+    TemplateInput,
+    Asset,
+    Logo,
+    Text,
+    ImageMimeType,
+    RenderRun,
+    RenderRunStatus,
+)
+
+# Create an asset
+asset = Asset(
+    width=1920,
+    height=1080,
+    mime_type=ImageMimeType.PNG,
+    parsing_label="hero_image",
+    s3Location={"bucket": "my-bucket", "key": "image.png"},
+)
+
+# Create template input design data
+from ods_models import TemplateInputDesignData
+
+design_data = TemplateInputDesignData(
+    assets=[asset],
+    logos=[],
+    texts=[],
+    extra_data={},
+)
+
+# Use with validation
+template_input = TemplateInput(
+    id="123",
+    template_registry_id="template-456",
+    inputs=design_data,
+    created_by="user@example.com",
+    updated_by="user@example.com",
+    account_id="account-789",
+    studio_id="studio-101",
+)
+```
+
+## Package Contents
+
+### Base Enums
+- `ImageMimeType` - Supported image MIME types
+- `ReviewStatusEnum` - Review status for workflows
+- `ImageTypeEnum` - Image type classification
+- `BatchTypeEnum`, `BatchStatusEnum` - Workflow batch types
+- `ExecutionStatusEnum` - Kore execution status
+
+### Models
+
+#### Template System
+- `TemplateRegistry` - Template metadata and configuration
+- `TemplateInput` - Template input with design data
+- `Asset`, `Logo`, `Text` - Design data elements
+- `InputParameters` - Template input specifications
+- `CanvasGlobals` - Canvas configuration (presets, guides, grids)
+
+#### Rendering
+- `RenderRun` - Batch rendering operations
+- `TargetInputJob` - Target input job processing
+
+#### Images & Workflows
+- `Image` - Image entity
+- `WorkflowExecutionResult` - Workflow execution results
+- `WorkflowBatch` - Workflow batch entity
+- `KoreExecution` - Kore execution entity
+
+#### Supporting Models
+- `GuideDoc` - Canvas guide definitions
+- `FlexPreset` - Canvas aspect ratio presets
+- `AssetSpecs`, `LogoSpecs`, `TextSpecs` - Input specifications
+
+## Features
+
+✅ **Type Safety**: Full Pydantic validation with Python type hints
+✅ **Compatible**: Matches TypeScript models in `@optikka/ods-models`
+✅ **Validated**: Runtime validation with Pydantic v2
+✅ **Documented**: Comprehensive docstrings and examples
+
+## Dependencies
+
+- `pydantic>=2.6.1,<3.0.0`
+- `ods-types-py>=0.1.0,<1.0.0`
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src/ tests/
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/
+```
+
+## Related Packages
+
+- `ods-types-py` - Core types and enums
+- `optikka-design-data-layer` - AWS utilities and clients
+
+## License
+
+PROPRIETARY - Optikka

ods_models_py-0.1.0/README.md

@@ -0,0 +1,129 @@
+# ods-models-py
+
+Pydantic data models for the ODS (Optikka Design System) - Python implementation.
+
+This is the Python equivalent of the `@optikka/ods-models` npm package, providing Pydantic models for templates, inputs, render runs, and related entities.
+
+## Installation
+
+```bash
+pip install ods-models-py
+```
+
+## Usage
+
+```python
+from ods_models import (
+    TemplateRegistry,
+    TemplateInput,
+    Asset,
+    Logo,
+    Text,
+    ImageMimeType,
+    RenderRun,
+    RenderRunStatus,
+)
+
+# Create an asset
+asset = Asset(
+    width=1920,
+    height=1080,
+    mime_type=ImageMimeType.PNG,
+    parsing_label="hero_image",
+    s3Location={"bucket": "my-bucket", "key": "image.png"},
+)
+
+# Create template input design data
+from ods_models import TemplateInputDesignData
+
+design_data = TemplateInputDesignData(
+    assets=[asset],
+    logos=[],
+    texts=[],
+    extra_data={},
+)
+
+# Use with validation
+template_input = TemplateInput(
+    id="123",
+    template_registry_id="template-456",
+    inputs=design_data,
+    created_by="user@example.com",
+    updated_by="user@example.com",
+    account_id="account-789",
+    studio_id="studio-101",
+)
+```
+
+## Package Contents
+
+### Base Enums
+- `ImageMimeType` - Supported image MIME types
+- `ReviewStatusEnum` - Review status for workflows
+- `ImageTypeEnum` - Image type classification
+- `BatchTypeEnum`, `BatchStatusEnum` - Workflow batch types
+- `ExecutionStatusEnum` - Kore execution status
+
+### Models
+
+#### Template System
+- `TemplateRegistry` - Template metadata and configuration
+- `TemplateInput` - Template input with design data
+- `Asset`, `Logo`, `Text` - Design data elements
+- `InputParameters` - Template input specifications
+- `CanvasGlobals` - Canvas configuration (presets, guides, grids)
+
+#### Rendering
+- `RenderRun` - Batch rendering operations
+- `TargetInputJob` - Target input job processing
+
+#### Images & Workflows
+- `Image` - Image entity
+- `WorkflowExecutionResult` - Workflow execution results
+- `WorkflowBatch` - Workflow batch entity
+- `KoreExecution` - Kore execution entity
+
+#### Supporting Models
+- `GuideDoc` - Canvas guide definitions
+- `FlexPreset` - Canvas aspect ratio presets
+- `AssetSpecs`, `LogoSpecs`, `TextSpecs` - Input specifications
+
+## Features
+
+✅ **Type Safety**: Full Pydantic validation with Python type hints
+✅ **Compatible**: Matches TypeScript models in `@optikka/ods-models`
+✅ **Validated**: Runtime validation with Pydantic v2
+✅ **Documented**: Comprehensive docstrings and examples
+
+## Dependencies
+
+- `pydantic>=2.6.1,<3.0.0`
+- `ods-types-py>=0.1.0,<1.0.0`
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src/ tests/
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/
+```
+
+## Related Packages
+
+- `ods-types-py` - Core types and enums
+- `optikka-design-data-layer` - AWS utilities and clients
+
+## License
+
+PROPRIETARY - Optikka

ods_models_py-0.1.0/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ods-models-py"
+version = "0.1.0"
+description = "Pydantic data models for ODS (Optikka Design System) - Python implementation"
+readme = "README.md"
+requires-python = ">=3.11"
+license = {text = "PROPRIETARY"}
+authors = [
+    {name = "Optikka", email = "dev@optikka.com"}
+]
+keywords = ["ods", "models", "pydantic", "renderer", "optikka"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+dependencies = [
+    "pydantic>=2.6.1,<3.0.0",
+    "ods-types-py>=0.1.0,<1.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "black>=23.0.0",
+    "ruff>=0.1.0",
+    "mypy>=1.5.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/optikka/ods"
+Repository = "https://github.com/optikka/ods"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 100
+target-version = ['py311']
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

ods_models_py-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ods_models_py-0.1.0/src/ods_models/__init__.py

@@ -0,0 +1,195 @@
+"""
+ODS Models - Python Implementation
+Pydantic data models for the ODS (Optikka Design System).
+Python equivalent of @optikka/ods-models npm package.
+"""
+
+__version__ = "0.1.0"
+
+# Re-export base enums
+from ods_models.base import (
+    ImageMimeType,
+    ReviewStatusEnum,
+    ImageTypeEnum,
+    BatchTypeEnum,
+    BatchStatusEnum,
+    ExecutionStatusEnum,
+    DesignDataInputTypes,
+    HTTPMethod,
+)
+
+# Re-export guides
+from ods_models.guides import GuideDoc
+
+# Re-export canvas globals
+from ods_models.canvas_globals import (
+    CanvasGuideKind,
+    CanvasGridKind,
+    BentoAxis,
+    FlexPreset,
+    CanvasGuides,
+    CanvasGridBase,
+    CanvasSimpleGridDef,
+    CanvasBentoGridDef,
+    CanvasBentoNode,
+    CanvasGridDef,
+    CanvasGlobals,
+)
+
+# Re-export input parameters
+from ods_models.input_parameters import (
+    TextTypeEnum,
+    AssetSpecs,
+    LogoSpecs,
+    TextSpecs,
+    InputParameters,
+    InputParametersPartialForCreate,
+)
+
+# Re-export template input
+from ods_models.template_input import (
+    Asset,
+    Logo,
+    Text,
+    TemplateInputDesignData,
+    TemplateInput,
+    TemplateInputWithoutId,
+    TemplateInputForCreate,
+)
+
+# Re-export template registry
+from ods_models.template_registry import (
+    TemplateRegistry,
+    TemplateRegistryWithoutId,
+    TemplateRegistryInputForCreate,
+    ODSScript,
+    TemplateRecipe,
+)
+
+# Re-export render run
+from ods_models.render_run import (
+    RenderRunStatus,
+    RenderRunQueueEventType,
+    RenderRun,
+    RenderRunInputForCreate,
+    RenderRunWithoutId,
+    StartRenderRunFromTargetInputJobInput,
+    TargetInputJobImage,
+    Progress,
+    Mapping,
+    TargetInputJobResult,
+    TargetInputJobStatus,
+    TargetInputJob,
+)
+
+# Re-export image and workflow models
+from ods_models.image import (
+    Image,
+    WorkflowExecutionResult,
+    WorkflowBatch,
+    KoreExecution,
+    ResizeParams,
+)
+
+# Re-export brand models
+from ods_models.brand import (
+    RGB,
+    HSL,
+    HSV,
+    CMYK,
+    Color,
+    ColorPalette,
+    BrandRule,
+    ImageQueryHint,
+    EntityAttributeSpec,
+    BrandRegistry,
+    BrandRegistryWithoutId,
+    BrandRegistryInputForCreate,
+    Brand,
+    BrandWithoutId,
+    BrandInputForCreate,
+    BrandInputWithoutId,
+)
+
+__all__ = [
+    # Base enums
+    "ImageMimeType",
+    "ReviewStatusEnum",
+    "ImageTypeEnum",
+    "BatchTypeEnum",
+    "BatchStatusEnum",
+    "ExecutionStatusEnum",
+    "DesignDataInputTypes",
+    "HTTPMethod",
+    # Guides
+    "GuideDoc",
+    # Canvas globals
+    "CanvasGuideKind",
+    "CanvasGridKind",
+    "BentoAxis",
+    "FlexPreset",
+    "CanvasGuides",
+    "CanvasGridBase",
+    "CanvasSimpleGridDef",
+    "CanvasBentoGridDef",
+    "CanvasBentoNode",
+    "CanvasGridDef",
+    "CanvasGlobals",
+    # Input parameters
+    "TextTypeEnum",
+    "AssetSpecs",
+    "LogoSpecs",
+    "TextSpecs",
+    "InputParameters",
+    "InputParametersPartialForCreate",
+    # Template input
+    "Asset",
+    "Logo",
+    "Text",
+    "TemplateInputDesignData",
+    "TemplateInput",
+    "TemplateInputWithoutId",
+    "TemplateInputForCreate",
+    # Template registry
+    "TemplateRegistry",
+    "TemplateRegistryWithoutId",
+    "TemplateRegistryInputForCreate",
+    "ODSScript",
+    "TemplateRecipe",
+    # Render run
+    "RenderRunStatus",
+    "RenderRunQueueEventType",
+    "RenderRun",
+    "RenderRunInputForCreate",
+    "RenderRunWithoutId",
+    "StartRenderRunFromTargetInputJobInput",
+    "TargetInputJobImage",
+    "Progress",
+    "Mapping",
+    "TargetInputJobResult",
+    "TargetInputJobStatus",
+    "TargetInputJob",
+    # Image and workflow
+    "Image",
+    "WorkflowExecutionResult",
+    "WorkflowBatch",
+    "KoreExecution",
+    "ResizeParams",
+    # Brand models
+    "RGB",
+    "HSL",
+    "HSV",
+    "CMYK",
+    "Color",
+    "ColorPalette",
+    "BrandRule",
+    "ImageQueryHint",
+    "EntityAttributeSpec",
+    "BrandRegistry",
+    "BrandRegistryWithoutId",
+    "BrandRegistryInputForCreate",
+    "Brand",
+    "BrandWithoutId",
+    "BrandInputForCreate",
+    "BrandInputWithoutId",
+]

ods_models_py-0.1.0/src/ods_models/base.py

@@ -0,0 +1,77 @@
+"""
+ODS Models - Base Types
+Base enums and types used across ODS models.
+Python equivalent of @optikka/ods-models/base
+"""
+
+from enum import Enum
+
+
+class ImageMimeType(str, Enum):
+    """
+    Image MIME types supported by ODS.
+    Matches design-data-microservices Python models.
+    """
+    PNG = "image/png"
+    JPEG = "image/jpeg"
+    GIF = "image/gif"
+    WEBP = "image/webp"
+    SVG = "image/svg+xml"
+
+
+class ReviewStatusEnum(str, Enum):
+    """Review status for workflow execution results"""
+    APPROVED = "APPROVED"
+    PENDING = "PENDING"
+    REJECTED = "REJECTED"
+
+
+class ImageTypeEnum(str, Enum):
+    """Image type classification"""
+    ORIGINAL = "ORIGINAL"
+    WORK_IN_PROGRESS = "WORK_IN_PROGRESS"
+    LEAF = "LEAF"
+    DEBUG = "DEBUG"
+
+
+class BatchTypeEnum(str, Enum):
+    """Workflow batch type"""
+    UPLOAD = "UPLOAD"
+    DOWNLOAD = "DOWNLOAD"
+    SHARED = "SHARED"
+    WORKFLOW_RUN = "WORKFLOW_RUN"
+
+
+class BatchStatusEnum(str, Enum):
+    """Workflow batch status"""
+    QUEUED = "QUEUED"
+    RUNNING = "RUNNING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+
+class ExecutionStatusEnum(str, Enum):
+    """Kore execution status"""
+    QUEUED = "QUEUED"
+    RUNNING = "RUNNING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+
+class DesignDataInputTypes(str, Enum):
+    """Design data input types"""
+    ASSETS = "assets"
+    LOGOS = "logos"
+    TEXTS = "texts"
+    EXTRA_DATA = "extra_data"
+
+
+class HTTPMethod(str, Enum):
+    """HTTP method"""
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    DELETE = "DELETE"
+    OPTIONS = "OPTIONS"
+    HEAD = "HEAD"