sudomock 0.1.0__tar.gz

sudomock-0.1.0/.gitignore

@@ -0,0 +1,32 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+
+# OS
+.DS_Store
+Thumbs.db

sudomock-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SudoMock Labs
+
+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.

sudomock-0.1.0/PKG-INFO

@@ -0,0 +1,254 @@
+Metadata-Version: 2.4
+Name: sudomock
+Version: 0.1.0
+Summary: Official Python SDK for the SudoMock Mockup Generator API
+Project-URL: Homepage, https://sudomock.com
+Project-URL: Documentation, https://docs.sudomock.com
+Project-URL: Repository, https://github.com/sudomock/sudomock-python
+Project-URL: Issues, https://github.com/sudomock/sudomock-python/issues
+Project-URL: Changelog, https://github.com/sudomock/sudomock-python/blob/main/CHANGELOG.md
+Author-email: SudoMock Labs <hello@sudomock.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,mockup,product-mockup,psd,sdk,sudomock
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx<1.0.0,>=0.27.0
+Requires-Dist: pydantic<3.0.0,>=2.7.0
+Requires-Dist: tenacity<10.0.0,>=9.0.0
+Provides-Extra: dev
+Requires-Dist: coverage>=7.6.0; extra == 'dev'
+Requires-Dist: mypy>=1.13.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# SudoMock Python SDK
+
+Official Python client for the [SudoMock](https://sudomock.com) Mockup Generator API.
+
+Generate photorealistic product mockups from PSD templates or AI-powered rendering -- all from your Python code.
+
+[![PyPI](https://img.shields.io/pypi/v/sudomock)](https://pypi.org/project/sudomock/)
+[![Python](https://img.shields.io/pypi/pyversions/sudomock)](https://pypi.org/project/sudomock/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![CI](https://github.com/sudomock/sudomock-python/actions/workflows/ci.yml/badge.svg)](https://github.com/sudomock/sudomock-python/actions)
+
+## Installation
+
+```bash
+pip install sudomock
+```
+
+## Quick Start
+
+```python
+from sudomock import SudoMock
+
+# 1. Create a client (or set SUDOMOCK_API_KEY env var)
+client = SudoMock(api_key="sm_your_api_key")
+
+# 2. List your mockup templates
+mockups = client.mockups.list(limit=10)
+for m in mockups.mockups:
+    print(f"{m.name} ({m.uuid})")
+
+# 3. Render a mockup with your artwork
+render = client.renders.create(
+    mockup_uuid=mockups.mockups[0].uuid,
+    smart_objects=[{
+        "uuid": mockups.mockups[0].smart_objects[0].uuid,
+        "asset": {"url": "https://example.com/your-design.png"},
+    }],
+)
+print(render.url)  # https://cdn.sudomock.com/renders/.../render.webp
+```
+
+## Async Usage
+
+```python
+import asyncio
+from sudomock import AsyncSudoMock
+
+async def main():
+    async with AsyncSudoMock(api_key="sm_your_api_key") as client:
+        mockups = await client.mockups.list()
+        render = await client.renders.create(
+            mockup_uuid=mockups.mockups[0].uuid,
+            smart_objects=[{
+                "uuid": mockups.mockups[0].smart_objects[0].uuid,
+                "asset": {"url": "https://example.com/design.png"},
+            }],
+        )
+        print(render.url)
+
+asyncio.run(main())
+```
+
+## AI Rendering (No PSD Required)
+
+```python
+from sudomock import SudoMock
+
+client = SudoMock(api_key="sm_your_api_key")
+
+# AI automatically detects the print area and applies perspective
+render = client.ai.render(
+    source_url="https://example.com/product-photo.jpg",
+    artwork_url="https://example.com/your-design.png",
+    product_type="t-shirt",  # optional hint
+)
+print(render.url)
+```
+
+## Error Handling
+
+```python
+from sudomock import SudoMock
+from sudomock.exceptions import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    RateLimitError,
+    NotFoundError,
+    ValidationError,
+    ServerError,
+    SudoMockError,  # base class for all errors
+)
+
+client = SudoMock(api_key="sm_your_api_key")
+
+try:
+    render = client.renders.create(
+        mockup_uuid="...",
+        smart_objects=[...],
+    )
+except AuthenticationError:
+    print("Invalid API key")
+except InsufficientCreditsError as e:
+    print(f"Out of credits. Resets at: {e.credits_reset_at}")
+except RateLimitError as e:
+    print(f"Rate limited. Retry after: {e.retry_after}s")
+except NotFoundError:
+    print("Mockup not found")
+except ValidationError:
+    print("Invalid request parameters")
+except ServerError:
+    print("Server error, will be retried automatically")
+except SudoMockError as e:
+    print(f"Unexpected error: {e.message} (HTTP {e.status_code})")
+```
+
+## Account & Credits
+
+```python
+from sudomock import SudoMock
+
+client = SudoMock(api_key="sm_your_api_key")
+account = client.account.get()
+
+print(f"Plan: {account.subscription.plan}")
+print(f"Credits remaining: {account.usage.credits_remaining}")
+print(f"Credits limit: {account.usage.credits_limit}")
+print(f"Period ends: {account.subscription.current_period_end}")
+```
+
+## Configuration
+
+```python
+from sudomock import SudoMock
+
+client = SudoMock(
+    api_key="sm_your_api_key",           # or SUDOMOCK_API_KEY env var
+    base_url="https://api.sudomock.com", # default
+    timeout=30.0,                         # default request timeout (seconds)
+    render_timeout=120.0,                 # render request timeout (seconds)
+    max_retries=3,                        # retry on 429/5xx (exponential backoff)
+)
+```
+
+## API Reference
+
+### Mockups
+
+| Method | Description |
+|--------|-------------|
+| `client.mockups.list(limit=, offset=, search=)` | List mockup templates |
+| `client.mockups.get(uuid)` | Get mockup details |
+| `client.mockups.delete(uuid)` | Delete a mockup |
+
+### Renders
+
+| Method | Description |
+|--------|-------------|
+| `client.renders.create(mockup_uuid=, smart_objects=, export_options=, export_label=)` | Render a mockup |
+
+### AI
+
+| Method | Description |
+|--------|-------------|
+| `client.ai.render(source_url=, artwork_url=, product_type=, ...)` | AI-powered render |
+
+### Account
+
+| Method | Description |
+|--------|-------------|
+| `client.account.get()` | Get account info, credits, subscription |
+
+### Export Options
+
+```python
+export_options = {
+    "image_format": "webp",  # "webp", "png", "jpg"
+    "image_size": 1920,       # max dimension in pixels
+    "quality": 95,            # 1-100 (for webp/jpg)
+}
+```
+
+### Smart Object Configuration
+
+```python
+smart_objects = [{
+    "uuid": "smart-object-uuid",
+    "asset": {
+        "url": "https://example.com/design.png",
+        "fit": "fill",      # "fill", "fit", "stretch"
+        "rotate": 0,         # degrees
+        "position": {"top": 100, "left": 100},
+        "size": {"width": 800, "height": 600},
+    },
+    "color": {
+        "hex": "#FFFFFF",
+        "blending_mode": "multiply",
+    },
+}]
+```
+
+## Requirements
+
+- Python 3.9+
+- [httpx](https://www.python-httpx.org/) for HTTP
+- [Pydantic v2](https://docs.pydantic.dev/) for response models
+- [tenacity](https://tenacity.readthedocs.io/) for retry logic
+
+## License
+
+MIT -- see [LICENSE](LICENSE).
+
+## Links
+
+- [SudoMock Website](https://sudomock.com)
+- [API Documentation](https://docs.sudomock.com)
+- [Dashboard](https://app.sudomock.com)

sudomock-0.1.0/README.md

@@ -0,0 +1,216 @@
+# SudoMock Python SDK
+
+Official Python client for the [SudoMock](https://sudomock.com) Mockup Generator API.
+
+Generate photorealistic product mockups from PSD templates or AI-powered rendering -- all from your Python code.
+
+[![PyPI](https://img.shields.io/pypi/v/sudomock)](https://pypi.org/project/sudomock/)
+[![Python](https://img.shields.io/pypi/pyversions/sudomock)](https://pypi.org/project/sudomock/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![CI](https://github.com/sudomock/sudomock-python/actions/workflows/ci.yml/badge.svg)](https://github.com/sudomock/sudomock-python/actions)
+
+## Installation
+
+```bash
+pip install sudomock
+```
+
+## Quick Start
+
+```python
+from sudomock import SudoMock
+
+# 1. Create a client (or set SUDOMOCK_API_KEY env var)
+client = SudoMock(api_key="sm_your_api_key")
+
+# 2. List your mockup templates
+mockups = client.mockups.list(limit=10)
+for m in mockups.mockups:
+    print(f"{m.name} ({m.uuid})")
+
+# 3. Render a mockup with your artwork
+render = client.renders.create(
+    mockup_uuid=mockups.mockups[0].uuid,
+    smart_objects=[{
+        "uuid": mockups.mockups[0].smart_objects[0].uuid,
+        "asset": {"url": "https://example.com/your-design.png"},
+    }],
+)
+print(render.url)  # https://cdn.sudomock.com/renders/.../render.webp
+```
+
+## Async Usage
+
+```python
+import asyncio
+from sudomock import AsyncSudoMock
+
+async def main():
+    async with AsyncSudoMock(api_key="sm_your_api_key") as client:
+        mockups = await client.mockups.list()
+        render = await client.renders.create(
+            mockup_uuid=mockups.mockups[0].uuid,
+            smart_objects=[{
+                "uuid": mockups.mockups[0].smart_objects[0].uuid,
+                "asset": {"url": "https://example.com/design.png"},
+            }],
+        )
+        print(render.url)
+
+asyncio.run(main())
+```
+
+## AI Rendering (No PSD Required)
+
+```python
+from sudomock import SudoMock
+
+client = SudoMock(api_key="sm_your_api_key")
+
+# AI automatically detects the print area and applies perspective
+render = client.ai.render(
+    source_url="https://example.com/product-photo.jpg",
+    artwork_url="https://example.com/your-design.png",
+    product_type="t-shirt",  # optional hint
+)
+print(render.url)
+```
+
+## Error Handling
+
+```python
+from sudomock import SudoMock
+from sudomock.exceptions import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    RateLimitError,
+    NotFoundError,
+    ValidationError,
+    ServerError,
+    SudoMockError,  # base class for all errors
+)
+
+client = SudoMock(api_key="sm_your_api_key")
+
+try:
+    render = client.renders.create(
+        mockup_uuid="...",
+        smart_objects=[...],
+    )
+except AuthenticationError:
+    print("Invalid API key")
+except InsufficientCreditsError as e:
+    print(f"Out of credits. Resets at: {e.credits_reset_at}")
+except RateLimitError as e:
+    print(f"Rate limited. Retry after: {e.retry_after}s")
+except NotFoundError:
+    print("Mockup not found")
+except ValidationError:
+    print("Invalid request parameters")
+except ServerError:
+    print("Server error, will be retried automatically")
+except SudoMockError as e:
+    print(f"Unexpected error: {e.message} (HTTP {e.status_code})")
+```
+
+## Account & Credits
+
+```python
+from sudomock import SudoMock
+
+client = SudoMock(api_key="sm_your_api_key")
+account = client.account.get()
+
+print(f"Plan: {account.subscription.plan}")
+print(f"Credits remaining: {account.usage.credits_remaining}")
+print(f"Credits limit: {account.usage.credits_limit}")
+print(f"Period ends: {account.subscription.current_period_end}")
+```
+
+## Configuration
+
+```python
+from sudomock import SudoMock
+
+client = SudoMock(
+    api_key="sm_your_api_key",           # or SUDOMOCK_API_KEY env var
+    base_url="https://api.sudomock.com", # default
+    timeout=30.0,                         # default request timeout (seconds)
+    render_timeout=120.0,                 # render request timeout (seconds)
+    max_retries=3,                        # retry on 429/5xx (exponential backoff)
+)
+```
+
+## API Reference
+
+### Mockups
+
+| Method | Description |
+|--------|-------------|
+| `client.mockups.list(limit=, offset=, search=)` | List mockup templates |
+| `client.mockups.get(uuid)` | Get mockup details |
+| `client.mockups.delete(uuid)` | Delete a mockup |
+
+### Renders
+
+| Method | Description |
+|--------|-------------|
+| `client.renders.create(mockup_uuid=, smart_objects=, export_options=, export_label=)` | Render a mockup |
+
+### AI
+
+| Method | Description |
+|--------|-------------|
+| `client.ai.render(source_url=, artwork_url=, product_type=, ...)` | AI-powered render |
+
+### Account
+
+| Method | Description |
+|--------|-------------|
+| `client.account.get()` | Get account info, credits, subscription |
+
+### Export Options
+
+```python
+export_options = {
+    "image_format": "webp",  # "webp", "png", "jpg"
+    "image_size": 1920,       # max dimension in pixels
+    "quality": 95,            # 1-100 (for webp/jpg)
+}
+```
+
+### Smart Object Configuration
+
+```python
+smart_objects = [{
+    "uuid": "smart-object-uuid",
+    "asset": {
+        "url": "https://example.com/design.png",
+        "fit": "fill",      # "fill", "fit", "stretch"
+        "rotate": 0,         # degrees
+        "position": {"top": 100, "left": 100},
+        "size": {"width": 800, "height": 600},
+    },
+    "color": {
+        "hex": "#FFFFFF",
+        "blending_mode": "multiply",
+    },
+}]
+```
+
+## Requirements
+
+- Python 3.9+
+- [httpx](https://www.python-httpx.org/) for HTTP
+- [Pydantic v2](https://docs.pydantic.dev/) for response models
+- [tenacity](https://tenacity.readthedocs.io/) for retry logic
+
+## License
+
+MIT -- see [LICENSE](LICENSE).
+
+## Links
+
+- [SudoMock Website](https://sudomock.com)
+- [API Documentation](https://docs.sudomock.com)
+- [Dashboard](https://app.sudomock.com)

sudomock-0.1.0/pyproject.toml

@@ -0,0 +1,91 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sudomock"
+version = "0.1.0"
+description = "Official Python SDK for the SudoMock Mockup Generator API"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    { name = "SudoMock Labs", email = "hello@sudomock.com" },
+]
+keywords = ["mockup", "api", "sdk", "sudomock", "product-mockup", "psd"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Multimedia :: Graphics",
+]
+dependencies = [
+    "httpx>=0.27.0,<1.0.0",
+    "pydantic>=2.7.0,<3.0.0",
+    "tenacity>=9.0.0,<10.0.0",
+]
+
+[project.urls]
+Homepage = "https://sudomock.com"
+Documentation = "https://docs.sudomock.com"
+Repository = "https://github.com/sudomock/sudomock-python"
+Issues = "https://github.com/sudomock/sudomock-python/issues"
+Changelog = "https://github.com/sudomock/sudomock-python/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3.0",
+    "pytest-asyncio>=0.24.0",
+    "respx>=0.22.0",
+    "ruff>=0.8.0",
+    "mypy>=1.13.0",
+    "coverage>=7.6.0",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/sudomock"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sudomock"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.ruff]
+target-version = "py39"
+line-length = 100
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = [
+    "E",    # pycodestyle errors
+    "W",    # pycodestyle warnings
+    "F",    # pyflakes
+    "I",    # isort
+    "UP",   # pyupgrade
+    "B",    # flake8-bugbear
+    "SIM",  # flake8-simplify
+    "TCH",  # flake8-type-checking
+]
+ignore = [
+    "SIM117",  # nested with -- parenthesized form requires Python 3.10+
+]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[[tool.mypy.overrides]]
+module = "tenacity.*"
+ignore_missing_imports = true

sudomock-0.1.0/src/sudomock/__init__.py

@@ -0,0 +1,88 @@
+"""SudoMock Python SDK -- official client for the SudoMock Mockup Generator API.
+
+Quick start::
+
+    from sudomock import SudoMock
+
+    client = SudoMock(api_key="sm_xxx")
+    mockups = client.mockups.list()
+    render = client.renders.create(
+        mockup_uuid=mockups.mockups[0].uuid,
+        smart_objects=[{
+            "uuid": mockups.mockups[0].smart_objects[0].uuid,
+            "asset": {"url": "https://example.com/design.png"},
+        }],
+    )
+    print(render.url)
+
+For async usage::
+
+    from sudomock import AsyncSudoMock
+
+    async with AsyncSudoMock(api_key="sm_xxx") as client:
+        mockups = await client.mockups.list()
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+
+from .async_client import AsyncSudoMock
+from .client import SudoMock
+from .exceptions import (
+    AuthenticationError,
+    InsufficientCreditsError,
+    NotFoundError,
+    RateLimitError,
+    ServerError,
+    SudoMockError,
+    ValidationError,
+)
+from .models import (
+    Account,
+    AccountInfo,
+    AIRender,
+    ApiKeyInfo,
+    Mockup,
+    MockupList,
+    PrintFile,
+    Render,
+    Size,
+    SmartObject,
+    Subscription,
+    Usage,
+)
+
+try:
+    __version__ = importlib.metadata.version("sudomock")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0-dev"
+
+__all__ = [
+    # Clients
+    "SudoMock",
+    "AsyncSudoMock",
+    # Models
+    "Account",
+    "AccountInfo",
+    "AIRender",
+    "ApiKeyInfo",
+    "Mockup",
+    "MockupList",
+    "PrintFile",
+    "Render",
+    "Size",
+    "SmartObject",
+    "Subscription",
+    "Usage",
+    # Exceptions
+    "SudoMockError",
+    "AuthenticationError",
+    "InsufficientCreditsError",
+    "NotFoundError",
+    "RateLimitError",
+    "ServerError",
+    "ValidationError",
+    # Meta
+    "__version__",
+]