artifex-api-python-sdk 0.1.1__tar.gz

artifex_api_python_sdk-0.1.1/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: artifex-api-python-sdk
+Version: 0.1.1
+Summary: Add your description here
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.0.0

artifex_api_python_sdk-0.1.1/README.md

@@ -0,0 +1,84 @@
+# Artifex Python SDK
+
+The official Python SDK for Artifex entities. This package provides high-performance, type-safe Pydantic V2 models for products, artwork, and geometry, making it easy to integrate with Artifex services.
+
+## Features
+
+- **Pydantic V2 Models**: Built on the latest Pydantic for high performance and strict validation.
+- **CamelCase Compatibility**: Seamlessly handles `camelCase` JSON from Java-based systems while providing Pythonic `snake_case` attribute access.
+- **Unit Conversion**: Built-in logic for converting between Metric (mm), Imperial (inches), points, and DPI-based pixel calculations.
+- **Type Safety**: Fully type-annotated for excellent IDE support and static analysis.
+
+## Installation
+
+```bash
+pip install artifex-api-python-sdk
+```
+
+Or using `uv`:
+
+```bash
+uv add artifex-api-python-sdk
+```
+
+## Quick Start
+
+### Parse Artifex JSON
+
+The SDK is designed to parse standard Artifex API responses.
+
+```python
+from artifex.entity.product.product import Product
+
+# Example Artifex JSON (camelCase)
+data = {
+    "productType": "FLYERS",
+    "artworkGeometry": {
+        "positions": [
+            {
+                "position": {"type": "FRONT", "pageOrSideNumber": 1},
+                "geometry": {"bleedTop": 3.0, "bleedRight": 3.0}
+            }
+        ]
+    }
+}
+
+# Deserialization
+product = Product.model_validate(data)
+
+# Access using Pythonic snake_case
+print(product.product_type)  # FLYERS
+print(product.artwork_geometry.positions[0].position.page_or_side_number)  # 1
+
+# Serialization to snake_case JSON
+print(product.model_dump_json(indent=2))
+
+# Serialization back to Artifex-compatible camelCase JSON
+print(product.model_dump_json(by_alias=True, indent=2))
+```
+
+### Unit Conversions
+
+Handle dimensions and geometric boxes with built-in conversion utilities.
+
+```python
+from artifex.entity.geometry.dimensions import Dimensions
+from artifex.entity.geometry.unit_format import UnitFormat
+
+# Create a metric dimension
+dim = Dimensions(width=210.0, height=297.0, size_format=UnitFormat.METRIC)
+
+# Convert to Imperial (inches)
+imperial = dim.to_imperial()
+print(f"{imperial.width}\" x {imperial.height}\"")
+
+# Convert to points (for PDF generation)
+points = dim.as_point()
+
+# Get dimensions at specific DPI
+pixels_300 = dim.as_300_dpi_pixel()
+```
+
+## License
+
+This project is licensed under the terms of the MIT license.

artifex_api_python_sdk-0.1.1/pyproject.toml

@@ -0,0 +1,8 @@
+[project]
+name = "artifex-api-python-sdk"
+version = "0.1.1"
+description = "Add your description here"
+requires-python = ">=3.11"
+dependencies = [
+    "pydantic>=2.0.0",
+]

artifex_api_python_sdk-0.1.1/setup.cfg

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

artifex_api_python_sdk-0.1.1/src/artifex/entity/artwork/artwork_geometry.py

@@ -0,0 +1,14 @@
+from typing import List, Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .position_geometry import PositionGeometry
+
+class ArtworkGeometry(BaseModel):
+    """A collection of artwork positions and their geometries"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    positions: Optional[List[PositionGeometry]] = Field(
+        default=None,
+        description="List of position and geometry pairs",
+        alias="positions"
+    )

artifex_api_python_sdk-0.1.1/src/artifex/entity/artwork/position.py

@@ -0,0 +1,20 @@
+from typing import Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .position_type import PositionType
+
+class Position(BaseModel):
+    """Represents a specific position within an artwork item"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    type: Optional[PositionType] = Field(
+        default=None,
+        description="The type of position",
+        alias="type"
+    )
+    page_or_side_number: Optional[int] = Field(
+        default=None,
+        description="The page or side number",
+        examples=[1],
+        alias="pageOrSideNumber"
+    )

artifex_api_python_sdk-0.1.1/src/artifex/entity/artwork/position_geometry.py

@@ -0,0 +1,20 @@
+from typing import Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .position import Position
+from ..geometry.geometry import Geometry
+
+class PositionGeometry(BaseModel):
+    """Combines a Position and its Geometry"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    position: Optional[Position] = Field(
+        default=None,
+        description="The position details",
+        alias="position"
+    )
+    geometry: Optional[Geometry] = Field(
+        default=None,
+        description="The geometry details for the position",
+        alias="geometry"
+    )

artifex_api_python_sdk-0.1.1/src/artifex/entity/artwork/position_type.py

@@ -0,0 +1,20 @@
+from enum import Enum
+
+class PositionType(str, Enum):
+    """
+    Possible types of artwork positions.
+    NOTE: the order of values is important! New artwork (uploaded by customers) will be organised
+    into positions (by the Asset server) in the order specified below.
+    """
+    FRONT = "FRONT"
+    BACK = "BACK"
+    COVER_SPREAD_OUTER = "COVER_SPREAD_OUTER"
+    COVER_SPREAD_INNER = "COVER_SPREAD_INNER"
+    DUST_JACKET = "DUST_JACKET"
+    DUST_JACKET_INNER = "DUST_JACKET_INNER"
+    SPINE = "SPINE"
+    FRONT_COVER_OUTER = "FRONT_COVER_OUTER"
+    FRONT_COVER_INNER = "FRONT_COVER_INNER"
+    BODY = "BODY"
+    BACK_COVER_INNER = "BACK_COVER_INNER"
+    BACK_COVER_OUTER = "BACK_COVER_OUTER"

artifex_api_python_sdk-0.1.1/src/artifex/entity/geometry/content_box.py

@@ -0,0 +1,32 @@
+from pydantic import ConfigDict, Field
+from .geometric_box import GeometricBox
+
+class ContentBox(GeometricBox):
+    """Box defining a content area with quiet zones"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    quiet_top: float = Field(
+        default=0.0,
+        description="Quiet zone at the top",
+        examples=[5.0],
+        alias="quietTop"
+    )
+    quiet_right: float = Field(
+        default=0.0,
+        description="Quiet zone on the right",
+        examples=[5.0],
+        alias="quietRight"
+    )
+    quiet_bottom: float = Field(
+        default=0.0,
+        description="Quiet zone at the bottom",
+        examples=[5.0],
+        alias="quietBottom"
+    )
+    quiet_left: float = Field(
+        default=0.0,
+        description="Quiet zone on the left",
+        examples=[5.0],
+        alias="quietLeft"
+    )

artifex_api_python_sdk-0.1.1/src/artifex/entity/geometry/dimensions.py

@@ -0,0 +1,101 @@
+from typing import Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .unit_format import UnitFormat
+
+class Dimensions(BaseModel):
+    """Dimensions of an object"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    MM_IN_INCH: float = 25.4
+    MM_IN_POINT: float = 2.8346456693
+    MM_IN_140_DPI_PIXEL: float = 5.51181102
+    MM_IN_300_DPI_PIXEL: float = 11.811023622
+    INCH_IN_POINT: float = 72.0
+    INCH_IN_140_DPI_PIXEL: float = 140.0
+    INCH_IN_300_DPI_PIXEL: float = 300.0
+
+    width: Optional[float] = Field(
+        default=None,
+        description="Width of the object",
+        examples=[210.0],
+        alias="width"
+    )
+    height: Optional[float] = Field(
+        default=None,
+        description="Height of the object",
+        examples=[297.0],
+        alias="height"
+    )
+    size_format: Optional[UnitFormat] = Field(
+        default=None,
+        description="Unit format for the dimensions",
+        alias="sizeFormat"
+    )
+
+    def to_size_format(self, format_type: UnitFormat) -> 'Dimensions':
+        if format_type == UnitFormat.IMPERIAL:
+            return self.to_imperial()
+        return self.to_metric()
+
+    def as_point(self) -> 'Dimensions':
+        if self.size_format == UnitFormat.IMPERIAL:
+            return Dimensions(
+                width=self.width * self.INCH_IN_POINT,
+                height=self.height * self.INCH_IN_POINT,
+                size_format=self.size_format
+            )
+        return Dimensions(
+            width=self.width * self.MM_IN_POINT,
+            height=self.height * self.MM_IN_POINT,
+            size_format=self.size_format
+        )
+
+    def as_140dpi_pixel(self) -> 'Dimensions':
+        if self.size_format == UnitFormat.IMPERIAL:
+            return Dimensions(
+                width=self.width * self.INCH_IN_140_DPI_PIXEL,
+                height=self.height * self.INCH_IN_140_DPI_PIXEL,
+                size_format=self.size_format
+            )
+        return Dimensions(
+            width=self.width * self.MM_IN_140_DPI_PIXEL,
+            height=self.height * self.MM_IN_140_DPI_PIXEL,
+            size_format=self.size_format
+        )
+
+    def as_300dpi_pixel(self) -> 'Dimensions':
+        if self.size_format == UnitFormat.IMPERIAL:
+            return Dimensions(
+                width=self.width * self.INCH_IN_300_DPI_PIXEL,
+                height=self.height * self.INCH_IN_300_DPI_PIXEL,
+                size_format=self.size_format
+            )
+        return Dimensions(
+            width=self.width * self.MM_IN_300_DPI_PIXEL,
+            height=self.height * self.MM_IN_300_DPI_PIXEL,
+            size_format=self.size_format
+        )
+
+    def to_imperial(self) -> 'Dimensions':
+        if self.size_format == UnitFormat.IMPERIAL:
+            return self
+        return Dimensions(
+            width=self.width / self.MM_IN_INCH,
+            height=self.height / self.MM_IN_INCH,
+            size_format=UnitFormat.IMPERIAL
+        )
+
+    def to_metric(self) -> 'Dimensions':
+        if self.size_format == UnitFormat.METRIC:
+            return self
+        return Dimensions(
+            width=self.width * self.MM_IN_INCH,
+            height=self.height * self.MM_IN_INCH,
+            size_format=UnitFormat.METRIC
+        )
+
+    def __str__(self) -> str:
+        if self.size_format == UnitFormat.METRIC:
+            return f"{self.width:.0f}mm X {self.height:.0f}mm"
+        return f"{self.width:.2f}\" X {self.height:.2f}\""

artifex_api_python_sdk-0.1.1/src/artifex/entity/geometry/geometric_box.py

@@ -0,0 +1,105 @@
+from enum import Enum
+from typing import List, Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .unit_format import UnitFormat
+
+class Edge(str, Enum):
+    TOP = "TOP"
+    RIGHT = "RIGHT"
+    BOTTOM = "BOTTOM"
+    LEFT = "LEFT"
+
+class BorderUnit(str, Enum):
+    LENGTH = "LENGTH"
+    PERCENTAGE = "PERCENTAGE"
+
+class GeometricBox(BaseModel):
+    """Base class for geometric shapes"""
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    x: float = Field(
+        default=0.0,
+        description="X coordinate of the box",
+        examples=[0.0],
+        alias="x"
+    )
+    y: float = Field(
+        default=0.0,
+        description="Y coordinate of the box",
+        examples=[0.0],
+        alias="y"
+    )
+    width: float = Field(
+        default=100.0,
+        description="Width of the box",
+        examples=[100.0],
+        alias="width"
+    )
+    height: float = Field(
+        default=100.0,
+        description="Height of the box",
+        examples=[100.0],
+        alias="height"
+    )
+
+    top_left_radius: float = Field(
+        default=0.0,
+        description="Radius for the top left corner",
+        examples=[0.0],
+        alias="topLeftRadius"
+    )
+    top_right_radius: float = Field(
+        default=0.0,
+        description="Radius for the top right corner",
+        examples=[0.0],
+        alias="topRightRadius"
+    )
+    bottom_right_radius: float = Field(
+        default=0.0,
+        description="Radius for the bottom right corner",
+        examples=[0.0],
+        alias="bottomRightRadius"
+    )
+    bottom_left_radius: float = Field(
+        default=0.0,
+        description="Radius for the bottom left corner",
+        examples=[0.0],
+        alias="bottomLeftRadius"
+    )
+
+    border_unit: Optional[BorderUnit] = Field(
+        default=None,
+        description="Unit used for the border radii",
+        alias="borderUnit"
+    )
+    inner_edges: Optional[List[Edge]] = Field(
+        default=None,
+        description="List of inner edges",
+        alias="innerEdges"
+    )
+    page_or_side_number: Optional[int] = Field(
+        default=None,
+        description="The page or side number this box belongs to",
+        examples=[1],
+        alias="pageOrSideNumber"
+    )
+
+    def as_point(self, from_format: UnitFormat) -> 'GeometricBox':
+        from .dimensions import Dimensions
+        
+        multiplier = Dimensions.INCH_IN_POINT if from_format == UnitFormat.IMPERIAL else Dimensions.MM_IN_POINT
+        
+        return GeometricBox(
+            x=self.x * multiplier,
+            y=self.y * multiplier,
+            width=self.width * multiplier,
+            height=self.height * multiplier,
+            top_left_radius=self.top_left_radius * multiplier,
+            top_right_radius=self.top_right_radius * multiplier,
+            bottom_right_radius=self.bottom_right_radius * multiplier,
+            bottom_left_radius=self.bottom_left_radius * multiplier,
+            border_unit=self.border_unit,
+            inner_edges=self.inner_edges,
+            page_or_side_number=self.page_or_side_number
+        )

artifex_api_python_sdk-0.1.1/src/artifex/entity/geometry/geometry.py

@@ -0,0 +1,44 @@
+from typing import List, Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .dimensions import Dimensions
+from .geometric_box import GeometricBox
+
+class Geometry(BaseModel):
+    """Geometry information for an artwork"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    trim_dimensions: Optional[Dimensions] = Field(
+        default=None,
+        description="Trim dimensions of the artwork",
+        alias="trimDimensions"
+    )
+    bleed_top: float = Field(
+        default=3.0,
+        description="Top bleed distance",
+        examples=[3.0],
+        alias="bleedTop"
+    )
+    bleed_right: float = Field(
+        default=3.0,
+        description="Right bleed distance",
+        examples=[3.0],
+        alias="bleedRight"
+    )
+    bleed_bottom: float = Field(
+        default=3.0,
+        description="Bottom bleed distance",
+        examples=[3.0],
+        alias="bleedBottom"
+    )
+    bleed_left: float = Field(
+        default=3.0,
+        description="Left bleed distance",
+        examples=[3.0],
+        alias="bleedLeft"
+    )
+    geometric_boxes: Optional[List[GeometricBox]] = Field(
+        default=None,
+        description="List of geometric boxes within the artwork",
+        alias="geometricBoxes"
+    )

artifex_api_python_sdk-0.1.1/src/artifex/entity/geometry/unit_format.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class UnitFormat(str, Enum):
+    """Unit format (Metric or Imperial)"""
+    METRIC = "METRIC"
+    IMPERIAL = "IMPERIAL"

artifex_api_python_sdk-0.1.1/src/artifex/entity/product/product.py

@@ -0,0 +1,20 @@
+from typing import Optional
+from pydantic import BaseModel, ConfigDict, Field
+from .product_type import ProductType
+from ..artwork.artwork_geometry import ArtworkGeometry
+
+class Product(BaseModel):
+    """Represents the schema for a product, including its type and artwork geometry"""
+
+    model_config = ConfigDict(populate_by_name=True)
+    
+    product_type: Optional[ProductType] = Field(
+        default=None,
+        description="The type of the product",
+        alias="productType"
+    )
+    artwork_geometry: Optional[ArtworkGeometry] = Field(
+        default=None,
+        description="The artwork geometry for the product",
+        alias="artworkGeometry"
+    )

artifex_api_python_sdk-0.1.1/src/artifex/entity/product/product_type.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+class ProductType(str, Enum):
+    """Possible types of products"""
+    BOOKMARKS = "BOOKMARKS"
+    BUSINESS_CARDS = "BUSINESS_CARDS"
+    FLYERS = "FLYERS"
+    POSTCARDS = "POSTCARDS"
+    POSTERS = "POSTERS"

artifex_api_python_sdk-0.1.1/src/artifex_api_python_sdk.egg-info/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: artifex-api-python-sdk
+Version: 0.1.1
+Summary: Add your description here
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.0.0

artifex_api_python_sdk-0.1.1/src/artifex_api_python_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+README.md
+pyproject.toml
+src/artifex/__init__.py
+src/artifex/entity/__init__.py
+src/artifex/entity/artwork/__init__.py
+src/artifex/entity/artwork/artwork_geometry.py
+src/artifex/entity/artwork/position.py
+src/artifex/entity/artwork/position_geometry.py
+src/artifex/entity/artwork/position_type.py
+src/artifex/entity/geometry/__init__.py
+src/artifex/entity/geometry/content_box.py
+src/artifex/entity/geometry/dimensions.py
+src/artifex/entity/geometry/geometric_box.py
+src/artifex/entity/geometry/geometry.py
+src/artifex/entity/geometry/unit_format.py
+src/artifex/entity/product/__init__.py
+src/artifex/entity/product/product.py
+src/artifex/entity/product/product_type.py
+src/artifex_api_python_sdk.egg-info/PKG-INFO
+src/artifex_api_python_sdk.egg-info/SOURCES.txt
+src/artifex_api_python_sdk.egg-info/dependency_links.txt
+src/artifex_api_python_sdk.egg-info/requires.txt
+src/artifex_api_python_sdk.egg-info/top_level.txt

artifex_api_python_sdk-0.1.1/src/artifex_api_python_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

artifex_api_python_sdk-0.1.1/src/artifex_api_python_sdk.egg-info/requires.txt

@@ -0,0 +1 @@
+pydantic>=2.0.0

artifex_api_python_sdk-0.1.1/src/artifex_api_python_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+artifex