imagepipeline 0.3.0__tar.gz

imagepipeline-0.3.0/.github/workflows/publish-sdk-python.yml

@@ -0,0 +1,33 @@
+name: Publish Python SDK to PyPI
+
+on:
+  release:
+    types: [published]   # triggers when you publish a GitHub Release
+
+jobs:
+  build-and-publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/imagepipeline
+
+    permissions:
+      id-token: write   # required for OIDC trusted publisher
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tool
+        run: pip install build
+
+      - name: Build
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

imagepipeline-0.3.0/.gitignore

@@ -0,0 +1,29 @@
+# Build artifacts
+dist/
+build/
+*.egg-info/
+*.egg
+wheels/
+
+# Bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Test / tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Editor / OS
+.idea/
+.vscode/
+.DS_Store

imagepipeline-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Model Pipeline AI, Inc.
+
+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.

imagepipeline-0.3.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: imagepipeline
+Version: 0.3.0
+Summary: On-model imagery for fast brands. The image AI API for fashion and ecommerce.
+Project-URL: Homepage, https://www.imagepipeline.io
+Project-URL: Documentation, https://docs.imagepipeline.io
+Project-URL: Book a demo, https://cal.com/imagepipeline/30min
+Project-URL: Repository, https://github.com/Model-Pipelines/imagepipeline-python
+Project-URL: Bug Tracker, https://github.com/Model-Pipelines/imagepipeline-python/issues
+License: MIT
+License-File: LICENSE
+Keywords: ai,background removal,ecommerce,fashion,image editing,image generation,imagepipeline,on-model,sdk,virtual try-on
+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: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.10; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: responses>=0.23; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# imagepipeline
+
+**On-model imagery for fast brands.**
+
+ImagePipeline is the image AI API for fashion and ecommerce. Turn flat-lays into on-model shots, run virtual try-on, and relight backgrounds — from one API. No studio, no photoshoot.
+
+[imagepipeline.io](https://www.imagepipeline.io) · [Book a demo](https://cal.com/imagepipeline/30min) · [Docs](https://docs.imagepipeline.io)
+
+---
+
+## Installation
+
+```bash
+pip install imagepipeline
+```
+
+Requires Python 3.9+ and a free API key from [imagepipeline.io](https://www.imagepipeline.io).
+
+---
+
+## Quick start
+
+```python
+from imagepipeline import ImagePipeline
+
+ip = ImagePipeline("ip_live_xxxxxxxxxxxx")
+
+# Turn a flat-lay into an on-model shot
+result = ip.generate.image(
+    prompt="fashion model wearing the product, white studio background, editorial lighting"
+)
+print(result.url)
+```
+
+---
+
+## Core use cases
+
+### Virtual try-on
+
+Dress a real person in any clothing item. Pass the model photo and the product image — ImagePipeline handles the compositing.
+
+```python
+result = ip.identity.tryon(
+    person_image="https://cdn.example.com/model.jpg",
+    clothing_image="https://cdn.example.com/shirt.jpg",
+    gender="woman",
+)
+print(result.url)
+```
+
+### Background replacement
+
+Swap a flat studio background for any scene. The subject is automatically isolated — no masking required. Describe the subject so it's preserved cleanly.
+
+```python
+result = ip.background.change(
+    input_image="https://cdn.example.com/product-shot.jpg",
+    prompt="minimal white marble surface, soft natural light",
+    subject_description="glass perfume bottle",
+)
+print(result.url)
+```
+
+### Background removal
+
+Cut out the subject as a transparent PNG, or recolor onto a flat background with an optional drop shadow.
+
+```python
+# Transparent cutout
+job = ip.background.remove(input_image="https://cdn.example.com/product.jpg")
+print(job.cutout_url)
+
+# Flat background + drop shadow
+job = ip.background.remove(
+    input_image="https://cdn.example.com/product.jpg",
+    recolor="#FFFFFF",
+    drop_shadow=True,
+)
+print(job.url)
+```
+
+### On-model image generation
+
+Generate consistent AI models with your brand's look and feel using identity profiles.
+
+```python
+# Create a reusable brand model profile
+profile = ip.identity.create_profile(
+    name="Campaign Model",
+    prompt_template="{{ user_prompt }}, Caucasian woman, late 20s, blue eyes, studio lighting",
+    seed_strategy="fixed",
+    fixed_seed=42,
+)
+
+# Generate on-model imagery with consistent identity
+result = ip.generate.image(
+    prompt="wearing a navy linen blazer, white background",
+    profile_id=profile["profile_id"],
+)
+print(result.url)
+```
+
+### Image editing
+
+Edit product images with natural-language instructions.
+
+```python
+result = ip.edit.image(
+    input_image="https://cdn.example.com/product.jpg",
+    prompt="remove the wrinkles from the fabric, keep everything else identical",
+)
+print(result.url)
+```
+
+### Upload & edit
+
+Upload local assets and use them directly in any editing workflow.
+
+```python
+# Upload a flat-lay image
+upload = ip.upload.image("flat-lay.jpg")
+
+# Then use it as an edit input
+result = ip.edit.image(
+    input_image=[upload.url, "https://cdn.example.com/model.jpg"],
+    prompt="put the model in the flat-lay clothing",
+    mask_segment="upper-clothes",
+)
+print(result.url)
+```
+
+### Targeted editing with segmentation
+
+Use segment detection to edit only the clothing — face, hair, and background stay pixel-perfect.
+
+```python
+# Optional: preview what segments exist in the image
+seg = ip.segment.image("https://cdn.example.com/model.jpg")
+for s in seg.segments:
+    print(s.label, "→", s.display)
+# upper-clothes → Top / Shirt
+# pants         → Pants
+
+# Edit only the detected segment
+result = ip.edit.image(
+    input_image=["https://cdn.example.com/model.jpg", "https://cdn.example.com/new-shirt.jpg"],
+    prompt="dress the model in the shirt from image 2",
+    mask_segment="upper-clothes",   # face, background, pants unchanged
+)
+print(result.url)
+```
+
+---
+
+## Async & webhooks
+
+All methods default to `wait=True` (blocks until the job completes). For high-throughput pipelines:
+
+```python
+# Fire-and-forget — returns immediately
+job = ip.generate.image(prompt="...", wait=False)
+print(job.job_id)
+
+# Poll manually when ready
+completed = ip._transport.poll("generate/image/v1", job.job_id)
+print(completed.url)
+
+# Or use a webhook — we POST a WebhookEvent to your URL on completion
+job = ip.identity.tryon(
+    person_image="https://...",
+    clothing_image="https://...",
+    callback_url="https://yourserver.com/hooks/imagepipeline",
+    wait=False,
+)
+```
+
+---
+
+## Error handling
+
+```python
+from imagepipeline.exceptions import (
+    AuthenticationError,
+    RateLimitError,
+    JobFailedError,
+    JobTimeoutError,
+    APIError,
+)
+
+try:
+    result = ip.generate.image(prompt="...")
+except AuthenticationError:
+    print("Invalid API key — get one at imagepipeline.io")
+except RateLimitError as e:
+    print(f"Rate limited — retry after {e.retry_after}s")
+except JobFailedError as e:
+    print(f"Job {e.job_id} failed: {e.reason}")
+except JobTimeoutError as e:
+    print(f"Timed out after {e.timeout}s")
+except APIError as e:
+    print(f"HTTP {e.status_code}")
+```
+
+---
+
+## API reference
+
+| Resource | Method | Description |
+|---|---|---|
+| `ip.generate` | `.image(prompt, ...)` | Text-to-image generation |
+| `ip.generate` | `.video(input_image, ...)` | Image-to-video |
+| `ip.generate` | `.speech(text, ...)` | Text-to-speech |
+| `ip.generate` | `.generate_3d(image_path, ...)` | Image-to-3D mesh |
+| `ip.edit` | `.image(prompt, input_image, ...)` | Instruction-based image editing |
+| `ip.background` | `.change(input_image, prompt, subject_description, ...)` | Background replacement |
+| `ip.background` | `.remove(input_image, recolor=None, ...)` | Background removal / cutout |
+| `ip.upscale` | `.image(input_image, scale=4, ...)` | AI image enhancement / upscale |
+| `ip.branding` | `.logo(input_image, logo_url, ...)` | Stamp a logo onto an image |
+| `ip.branding` | `.template(input_image, ...)` | Brand Scene Composer (palette-matched background) |
+| `ip.upload` | `.image(file)` | Upload an image, receive a URL |
+| `ip.segment` | `.image(image_url)` | Detect segments for targeted editing |
+| `ip.identity` | `.tryon(person_image, clothing_image, ...)` | Virtual try-on |
+| `ip.identity` | `.faceswap(source, target, ...)` | Face swap |
+| `ip.identity` | `.lock(input_image, prompt, ...)` | Identity-locked generation |
+| `ip.identity` | `.replace(input_image, prompt, ...)` | Person/model replacement |
+| `ip.identity` | `.instamodel(face_image, prompt, ...)` | Consistent AI model imagery |
+| `ip.identity` | `.voice_clone(text, reference_voice_url, ...)` | Voice cloning |
+| `ip.identity` | `.create_profile(name, ...)` | Create a reusable identity profile |
+| `ip.identity` | `.list_profiles()` | List identity profiles |
+| `ip.identity` | `.get_profile(profile_id)` | Fetch a profile |
+| `ip.identity` | `.delete_profile(profile_id)` | Delete a profile |
+
+---
+
+## Requirements
+
+- Python 3.9+
+- `requests`
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+[imagepipeline.io](https://www.imagepipeline.io) · [Book a demo](https://cal.com/imagepipeline/30min) · [Docs](https://docs.imagepipeline.io)

imagepipeline-0.3.0/README.md

@@ -0,0 +1,247 @@
+# imagepipeline
+
+**On-model imagery for fast brands.**
+
+ImagePipeline is the image AI API for fashion and ecommerce. Turn flat-lays into on-model shots, run virtual try-on, and relight backgrounds — from one API. No studio, no photoshoot.
+
+[imagepipeline.io](https://www.imagepipeline.io) · [Book a demo](https://cal.com/imagepipeline/30min) · [Docs](https://docs.imagepipeline.io)
+
+---
+
+## Installation
+
+```bash
+pip install imagepipeline
+```
+
+Requires Python 3.9+ and a free API key from [imagepipeline.io](https://www.imagepipeline.io).
+
+---
+
+## Quick start
+
+```python
+from imagepipeline import ImagePipeline
+
+ip = ImagePipeline("ip_live_xxxxxxxxxxxx")
+
+# Turn a flat-lay into an on-model shot
+result = ip.generate.image(
+    prompt="fashion model wearing the product, white studio background, editorial lighting"
+)
+print(result.url)
+```
+
+---
+
+## Core use cases
+
+### Virtual try-on
+
+Dress a real person in any clothing item. Pass the model photo and the product image — ImagePipeline handles the compositing.
+
+```python
+result = ip.identity.tryon(
+    person_image="https://cdn.example.com/model.jpg",
+    clothing_image="https://cdn.example.com/shirt.jpg",
+    gender="woman",
+)
+print(result.url)
+```
+
+### Background replacement
+
+Swap a flat studio background for any scene. The subject is automatically isolated — no masking required. Describe the subject so it's preserved cleanly.
+
+```python
+result = ip.background.change(
+    input_image="https://cdn.example.com/product-shot.jpg",
+    prompt="minimal white marble surface, soft natural light",
+    subject_description="glass perfume bottle",
+)
+print(result.url)
+```
+
+### Background removal
+
+Cut out the subject as a transparent PNG, or recolor onto a flat background with an optional drop shadow.
+
+```python
+# Transparent cutout
+job = ip.background.remove(input_image="https://cdn.example.com/product.jpg")
+print(job.cutout_url)
+
+# Flat background + drop shadow
+job = ip.background.remove(
+    input_image="https://cdn.example.com/product.jpg",
+    recolor="#FFFFFF",
+    drop_shadow=True,
+)
+print(job.url)
+```
+
+### On-model image generation
+
+Generate consistent AI models with your brand's look and feel using identity profiles.
+
+```python
+# Create a reusable brand model profile
+profile = ip.identity.create_profile(
+    name="Campaign Model",
+    prompt_template="{{ user_prompt }}, Caucasian woman, late 20s, blue eyes, studio lighting",
+    seed_strategy="fixed",
+    fixed_seed=42,
+)
+
+# Generate on-model imagery with consistent identity
+result = ip.generate.image(
+    prompt="wearing a navy linen blazer, white background",
+    profile_id=profile["profile_id"],
+)
+print(result.url)
+```
+
+### Image editing
+
+Edit product images with natural-language instructions.
+
+```python
+result = ip.edit.image(
+    input_image="https://cdn.example.com/product.jpg",
+    prompt="remove the wrinkles from the fabric, keep everything else identical",
+)
+print(result.url)
+```
+
+### Upload & edit
+
+Upload local assets and use them directly in any editing workflow.
+
+```python
+# Upload a flat-lay image
+upload = ip.upload.image("flat-lay.jpg")
+
+# Then use it as an edit input
+result = ip.edit.image(
+    input_image=[upload.url, "https://cdn.example.com/model.jpg"],
+    prompt="put the model in the flat-lay clothing",
+    mask_segment="upper-clothes",
+)
+print(result.url)
+```
+
+### Targeted editing with segmentation
+
+Use segment detection to edit only the clothing — face, hair, and background stay pixel-perfect.
+
+```python
+# Optional: preview what segments exist in the image
+seg = ip.segment.image("https://cdn.example.com/model.jpg")
+for s in seg.segments:
+    print(s.label, "→", s.display)
+# upper-clothes → Top / Shirt
+# pants         → Pants
+
+# Edit only the detected segment
+result = ip.edit.image(
+    input_image=["https://cdn.example.com/model.jpg", "https://cdn.example.com/new-shirt.jpg"],
+    prompt="dress the model in the shirt from image 2",
+    mask_segment="upper-clothes",   # face, background, pants unchanged
+)
+print(result.url)
+```
+
+---
+
+## Async & webhooks
+
+All methods default to `wait=True` (blocks until the job completes). For high-throughput pipelines:
+
+```python
+# Fire-and-forget — returns immediately
+job = ip.generate.image(prompt="...", wait=False)
+print(job.job_id)
+
+# Poll manually when ready
+completed = ip._transport.poll("generate/image/v1", job.job_id)
+print(completed.url)
+
+# Or use a webhook — we POST a WebhookEvent to your URL on completion
+job = ip.identity.tryon(
+    person_image="https://...",
+    clothing_image="https://...",
+    callback_url="https://yourserver.com/hooks/imagepipeline",
+    wait=False,
+)
+```
+
+---
+
+## Error handling
+
+```python
+from imagepipeline.exceptions import (
+    AuthenticationError,
+    RateLimitError,
+    JobFailedError,
+    JobTimeoutError,
+    APIError,
+)
+
+try:
+    result = ip.generate.image(prompt="...")
+except AuthenticationError:
+    print("Invalid API key — get one at imagepipeline.io")
+except RateLimitError as e:
+    print(f"Rate limited — retry after {e.retry_after}s")
+except JobFailedError as e:
+    print(f"Job {e.job_id} failed: {e.reason}")
+except JobTimeoutError as e:
+    print(f"Timed out after {e.timeout}s")
+except APIError as e:
+    print(f"HTTP {e.status_code}")
+```
+
+---
+
+## API reference
+
+| Resource | Method | Description |
+|---|---|---|
+| `ip.generate` | `.image(prompt, ...)` | Text-to-image generation |
+| `ip.generate` | `.video(input_image, ...)` | Image-to-video |
+| `ip.generate` | `.speech(text, ...)` | Text-to-speech |
+| `ip.generate` | `.generate_3d(image_path, ...)` | Image-to-3D mesh |
+| `ip.edit` | `.image(prompt, input_image, ...)` | Instruction-based image editing |
+| `ip.background` | `.change(input_image, prompt, subject_description, ...)` | Background replacement |
+| `ip.background` | `.remove(input_image, recolor=None, ...)` | Background removal / cutout |
+| `ip.upscale` | `.image(input_image, scale=4, ...)` | AI image enhancement / upscale |
+| `ip.branding` | `.logo(input_image, logo_url, ...)` | Stamp a logo onto an image |
+| `ip.branding` | `.template(input_image, ...)` | Brand Scene Composer (palette-matched background) |
+| `ip.upload` | `.image(file)` | Upload an image, receive a URL |
+| `ip.segment` | `.image(image_url)` | Detect segments for targeted editing |
+| `ip.identity` | `.tryon(person_image, clothing_image, ...)` | Virtual try-on |
+| `ip.identity` | `.faceswap(source, target, ...)` | Face swap |
+| `ip.identity` | `.lock(input_image, prompt, ...)` | Identity-locked generation |
+| `ip.identity` | `.replace(input_image, prompt, ...)` | Person/model replacement |
+| `ip.identity` | `.instamodel(face_image, prompt, ...)` | Consistent AI model imagery |
+| `ip.identity` | `.voice_clone(text, reference_voice_url, ...)` | Voice cloning |
+| `ip.identity` | `.create_profile(name, ...)` | Create a reusable identity profile |
+| `ip.identity` | `.list_profiles()` | List identity profiles |
+| `ip.identity` | `.get_profile(profile_id)` | Fetch a profile |
+| `ip.identity` | `.delete_profile(profile_id)` | Delete a profile |
+
+---
+
+## Requirements
+
+- Python 3.9+
+- `requests`
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+---
+
+[imagepipeline.io](https://www.imagepipeline.io) · [Book a demo](https://cal.com/imagepipeline/30min) · [Docs](https://docs.imagepipeline.io)

imagepipeline-0.3.0/imagepipeline/__init__.py

@@ -0,0 +1,7 @@
+"""ImagePipeline Python SDK"""
+
+from .client import ImagePipeline
+from .models import Job, JobStatus, SegmentItem, SegmentResult, UploadResult
+
+__all__ = ["ImagePipeline", "Job", "JobStatus", "UploadResult", "SegmentItem", "SegmentResult"]
+__version__ = "0.3.0"