smallpict 0.0.1__tar.gz

smallpict-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test & Lint (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev,pil]"
+
+      - name: Lint with Ruff
+        run: ruff check .
+
+      - name: Type check with MyPy
+        run: mypy smallpict
+
+      - name: Run Pytest
+        run: pytest -v

smallpict-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: 📦 Publish to PyPI (OIDC)
+    environment: release
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install build tools
+        run: pip install hatch
+      - name: Build wheel and source dist
+        run: hatch build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

smallpict-0.0.1/.gitignore

@@ -0,0 +1,31 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+.env
+.venv
+env/
+venv/
+ENV/
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+.DS_Store

smallpict-0.0.1/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to the `smallpict` Python SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-08-22
+
+### Added
+- Official Python SDK implementation for SmallPict OpenAPI 3.1.0 API.
+- First-class `SmallPictClient` (sync) and `AsyncSmallPictClient` (async) clients powered by `httpx`.
+- Context manager support (`with` and `async with`).
+- Pydantic models for request options and response payloads.
+- 4 unified core client methods: `optimize()`, `get_quota()`, `purge_cdn()`, and `validate_key()`.
+- Helper `get_job_status()` for polling async conversion tasks.
+- Optional Pillow / PIL integration (`smallpict[pil]`) supporting direct `PIL.Image` input.
+- Automatic secret masking to ensure API keys and signatures never leak in exception strings.
+- Resilient HTTP transport with 30s timeouts, exponential backoff, jitter, and automatic `Idempotency-Key` UUID injection.
+- Optional `fallback_mode=FallbackMode.PASSTHROUGH` for high availability on quota limits.
+- Full type annotations (PEP 561 `py.typed`) and strict `mypy` compatibility.

smallpict-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SmallPict Engineering <support@smallpict.app>
+
+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.

smallpict-0.0.1/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.5
+Name: smallpict
+Version: 0.0.1
+Summary: Official Python SDK for SmallPict Image Optimization API
+Project-URL: Homepage, https://smallpict.app
+Project-URL: Repository, https://github.com/tuxnoob/smallpict-python
+Project-URL: Documentation, https://smallpict.app/docs/sdks/python
+Project-URL: Changelog, https://github.com/tuxnoob/smallpict-python/blob/main/CHANGELOG.md
+Author-email: SmallPict Engineering <support@smallpict.app>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: pil
+Requires-Dist: pillow>=9.0.0; extra == 'pil'
+Description-Content-Type: text/markdown
+
+# SmallPict Python SDK
+
+Official Python client for the [SmallPict Image Optimization API](https://smallpict.app) — high-performance next-gen image transcoding (AVIF, WebP), smart compression, Edge CDN delivery, and cache purging.
+
+[![PyPI version](https://img.shields.io/pypi/v/smallpict.svg)](https://pypi.org/project/smallpict/)
+[![Python versions](https://img.shields.io/pypi/pyversions/smallpict.svg)](https://pypi.org/project/smallpict/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## ⚡ Features
+
+- **🚀 Synchronous & Asynchronous:** First-class sync (`SmallPictClient`) and async (`AsyncSmallPictClient`) clients powered by `httpx`.
+- **🖼️ Optional Pillow / PIL Support:** Optimize `PIL.Image` instances directly via `pip install smallpict[pil]`.
+- **🛡️ Secure HMAC-SHA256 & Bearer Auth:** Tamper-proof payload verification.
+- **✨ 4 Core Unified Methods:** `optimize()`, `get_quota()`, `purge_cdn()`, and `validate_key()`.
+- **🔄 Resilience & Fault Tolerance:** Automatic `Idempotency-Key` UUID injection, 30s timeouts, and exponential backoff with jitter on HTTP 429/5xx.
+- **🔒 Zero-Leak Privacy:** API keys and credentials are automatically redacted from error traces and logs.
+- **🏷️ Fully Typed:** Complete type annotations (PEP 561 `py.typed`) and strict `mypy` compatibility.
+
+---
+
+## 📥 Installation
+
+```bash
+# Standard installation
+pip install smallpict
+
+# With optional Pillow / PIL integration
+pip install "smallpict[pil]"
+
+# With poetry
+poetry add smallpict
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Synchronous Example
+
+```python
+import os
+from smallpict import SmallPictClient
+
+client = SmallPictClient(
+    api_key=os.environ["SMALLPICT_API_KEY"],
+    secret_key=os.environ.get("SMALLPICT_SECRET_KEY"),
+)
+
+with open("hero-banner.png", "rb") as f:
+    image_bytes = f.read()
+
+result = client.optimize(
+    image_bytes,
+    filename="hero-banner.png",
+    format="avif",
+    quality=80,
+    max_width=1920,
+)
+
+print(f"Optimized CDN URL: {result.url}")
+print(f"Original: {result.original_size}B ➔ Compressed: {result.compressed_size}B")
+print(f"Saved: {result.savings_percentage}% ({result.bytes_saved} bytes)")
+```
+
+### 2. Asynchronous Example (FastAPI / Starlette)
+
+```python
+import os
+from fastapi import FastAPI, UploadFile, File
+from smallpict import AsyncSmallPictClient
+
+app = FastAPI()
+client = AsyncSmallPictClient(api_key=os.environ["SMALLPICT_API_KEY"])
+
+
+@app.post("/upload")
+async def upload_image(file: UploadFile = File(...)):
+    contents = await file.read()
+    
+    result = await client.optimize(
+        contents,
+        filename=file.filename,
+        format="auto", # Intelligently selects best format (AVIF/WebP)
+        quality=85,
+    )
+    
+    return {
+        "url": result.url,
+        "format": result.format,
+        "saved_percentage": f"{result.savings_percentage}%",
+    }
+```
+
+### 3. Celery Background Worker Task
+
+```python
+import os
+from celery import Celery
+from smallpict import SmallPictClient
+
+app = Celery("tasks", broker="redis://localhost:6379/0")
+client = SmallPictClient(api_key=os.environ["SMALLPICT_API_KEY"])
+
+
+@app.task
+def process_user_avatar(file_path: str):
+    result = client.optimize(
+        file_path,
+        format="webp",
+        quality=80,
+        max_width=400,
+        max_height=400,
+    )
+    return {"cdn_url": result.url, "bytes_saved": result.bytes_saved}
+```
+
+### 4. Optional Pillow / PIL Integration
+
+```python
+from PIL import Image
+from smallpict import SmallPictClient
+
+img = Image.open("photo.jpg")
+# Crop or transform with Pillow
+img_cropped = img.crop((0, 0, 800, 600))
+
+client = SmallPictClient(api_key="sp_live_...")
+result = client.optimize(img_cropped, format="avif", quality=85)
+print(f"Delivered via CDN: {result.url}")
+```
+
+---
+
+## 📊 Checking Quota & Invalidating CDN Cache
+
+```python
+from smallpict import SmallPictClient
+
+client = SmallPictClient(api_key="sp_live_...")
+
+# 1. Real-time quota metrics
+quota = client.get_quota()
+print(f"Plan: {quota.plan}, Used: {quota.quota_percentage}%")
+
+# 2. Invalidate CDN cache
+client.purge_cdn(["https://cdn.smallpict.app/opt/hero-banner.avif"])
+print("CDN edge cache invalidated successfully.")
+```
+
+---
+
+## 🧪 Testing
+
+```bash
+pytest
+mypy smallpict
+ruff check .
+```
+
+---
+
+## 📄 License
+
+MIT © [SmallPict Engineering](https://smallpict.app)

smallpict-0.0.1/README.md

@@ -0,0 +1,166 @@
+# SmallPict Python SDK
+
+Official Python client for the [SmallPict Image Optimization API](https://smallpict.app) — high-performance next-gen image transcoding (AVIF, WebP), smart compression, Edge CDN delivery, and cache purging.
+
+[![PyPI version](https://img.shields.io/pypi/v/smallpict.svg)](https://pypi.org/project/smallpict/)
+[![Python versions](https://img.shields.io/pypi/pyversions/smallpict.svg)](https://pypi.org/project/smallpict/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## ⚡ Features
+
+- **🚀 Synchronous & Asynchronous:** First-class sync (`SmallPictClient`) and async (`AsyncSmallPictClient`) clients powered by `httpx`.
+- **🖼️ Optional Pillow / PIL Support:** Optimize `PIL.Image` instances directly via `pip install smallpict[pil]`.
+- **🛡️ Secure HMAC-SHA256 & Bearer Auth:** Tamper-proof payload verification.
+- **✨ 4 Core Unified Methods:** `optimize()`, `get_quota()`, `purge_cdn()`, and `validate_key()`.
+- **🔄 Resilience & Fault Tolerance:** Automatic `Idempotency-Key` UUID injection, 30s timeouts, and exponential backoff with jitter on HTTP 429/5xx.
+- **🔒 Zero-Leak Privacy:** API keys and credentials are automatically redacted from error traces and logs.
+- **🏷️ Fully Typed:** Complete type annotations (PEP 561 `py.typed`) and strict `mypy` compatibility.
+
+---
+
+## 📥 Installation
+
+```bash
+# Standard installation
+pip install smallpict
+
+# With optional Pillow / PIL integration
+pip install "smallpict[pil]"
+
+# With poetry
+poetry add smallpict
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Synchronous Example
+
+```python
+import os
+from smallpict import SmallPictClient
+
+client = SmallPictClient(
+    api_key=os.environ["SMALLPICT_API_KEY"],
+    secret_key=os.environ.get("SMALLPICT_SECRET_KEY"),
+)
+
+with open("hero-banner.png", "rb") as f:
+    image_bytes = f.read()
+
+result = client.optimize(
+    image_bytes,
+    filename="hero-banner.png",
+    format="avif",
+    quality=80,
+    max_width=1920,
+)
+
+print(f"Optimized CDN URL: {result.url}")
+print(f"Original: {result.original_size}B ➔ Compressed: {result.compressed_size}B")
+print(f"Saved: {result.savings_percentage}% ({result.bytes_saved} bytes)")
+```
+
+### 2. Asynchronous Example (FastAPI / Starlette)
+
+```python
+import os
+from fastapi import FastAPI, UploadFile, File
+from smallpict import AsyncSmallPictClient
+
+app = FastAPI()
+client = AsyncSmallPictClient(api_key=os.environ["SMALLPICT_API_KEY"])
+
+
+@app.post("/upload")
+async def upload_image(file: UploadFile = File(...)):
+    contents = await file.read()
+    
+    result = await client.optimize(
+        contents,
+        filename=file.filename,
+        format="auto", # Intelligently selects best format (AVIF/WebP)
+        quality=85,
+    )
+    
+    return {
+        "url": result.url,
+        "format": result.format,
+        "saved_percentage": f"{result.savings_percentage}%",
+    }
+```
+
+### 3. Celery Background Worker Task
+
+```python
+import os
+from celery import Celery
+from smallpict import SmallPictClient
+
+app = Celery("tasks", broker="redis://localhost:6379/0")
+client = SmallPictClient(api_key=os.environ["SMALLPICT_API_KEY"])
+
+
+@app.task
+def process_user_avatar(file_path: str):
+    result = client.optimize(
+        file_path,
+        format="webp",
+        quality=80,
+        max_width=400,
+        max_height=400,
+    )
+    return {"cdn_url": result.url, "bytes_saved": result.bytes_saved}
+```
+
+### 4. Optional Pillow / PIL Integration
+
+```python
+from PIL import Image
+from smallpict import SmallPictClient
+
+img = Image.open("photo.jpg")
+# Crop or transform with Pillow
+img_cropped = img.crop((0, 0, 800, 600))
+
+client = SmallPictClient(api_key="sp_live_...")
+result = client.optimize(img_cropped, format="avif", quality=85)
+print(f"Delivered via CDN: {result.url}")
+```
+
+---
+
+## 📊 Checking Quota & Invalidating CDN Cache
+
+```python
+from smallpict import SmallPictClient
+
+client = SmallPictClient(api_key="sp_live_...")
+
+# 1. Real-time quota metrics
+quota = client.get_quota()
+print(f"Plan: {quota.plan}, Used: {quota.quota_percentage}%")
+
+# 2. Invalidate CDN cache
+client.purge_cdn(["https://cdn.smallpict.app/opt/hero-banner.avif"])
+print("CDN edge cache invalidated successfully.")
+```
+
+---
+
+## 🧪 Testing
+
+```bash
+pytest
+mypy smallpict
+ruff check .
+```
+
+---
+
+## 📄 License
+
+MIT © [SmallPict Engineering](https://smallpict.app)

smallpict-0.0.1/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+Please report vulnerabilities directly to [security@smallpict.app](mailto:security@smallpict.app).
+
+Do not log raw API keys, signatures, or full image payloads.

smallpict-0.0.1/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "smallpict"
+version = "0.0.1"
+description = "Official Python SDK for SmallPict Image Optimization API"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.8"
+authors = [
+    { name = "SmallPict Engineering", email = "support@smallpict.app" }
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Multimedia :: Graphics",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.24.0",
+    "pydantic>=2.0.0",
+]
+
+[project.optional-dependencies]
+pil = [
+    "Pillow>=9.0.0",
+]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "respx>=0.21.0",
+    "mypy>=1.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://smallpict.app"
+Repository = "https://github.com/tuxnoob/smallpict-python"
+Documentation = "https://smallpict.app/docs/sdks/python"
+Changelog = "https://github.com/tuxnoob/smallpict-python/blob/main/CHANGELOG.md"
+
+[tool.hatch.build.targets.wheel]
+packages = ["smallpict"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py38"
+
+[tool.mypy]
+python_version = "3.8"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

smallpict-0.0.1/smallpict/__init__.py

@@ -0,0 +1,61 @@
+"""
+SmallPict Official Python SDK
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+High-performance cloud image optimization, format transcoding (WebP, AVIF),
+CDN edge invalidation, and real-time quota tracking.
+"""
+
+from .client import SmallPictClient
+from .aclient import AsyncSmallPictClient
+from .errors import (
+    SmallPictError,
+    ValidationError,
+    AuthenticationError,
+    PermissionDeniedError,
+    NotFoundError,
+    QuotaExceededError,
+    RateLimitError,
+    ServerError,
+    TimeoutError,
+    NetworkError,
+    sanitize_message,
+)
+from .models import (
+    ImageFormat,
+    FitMode,
+    FallbackMode,
+    PurgeType,
+    OptimizeOptions,
+    OptimizeResult,
+    JobStatusResult,
+    QuotaResponse,
+    PurgeOptions,
+    PurgeResponse,
+)
+
+__version__ = "0.0.1"
+__all__ = [
+    "SmallPictClient",
+    "AsyncSmallPictClient",
+    "SmallPictError",
+    "ValidationError",
+    "AuthenticationError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "QuotaExceededError",
+    "RateLimitError",
+    "ServerError",
+    "TimeoutError",
+    "NetworkError",
+    "sanitize_message",
+    "ImageFormat",
+    "FitMode",
+    "FallbackMode",
+    "PurgeType",
+    "OptimizeOptions",
+    "OptimizeResult",
+    "JobStatusResult",
+    "QuotaResponse",
+    "PurgeOptions",
+    "PurgeResponse",
+]