styleysdk 0.1.3

No project description provided

Styley Python SDK

📚 Table of Contents

1. Introduction
2. Install Python
3. Verify Installation
4. Install SDK
5. Environment Variables
6. Usage
   • Deployments
   • Models
7. Class & Method Reference

---

Introduction

The Styley Python SDK provides a simple and intuitive interface to interact with Styley’s deployment and model services. With this SDK, you can easily create and manage deployments, query models, and retrieve job statuses programmatically.

---

Install Python

Install Using Official Installer (Recommended)

1. Download Python

   • Visit Python official download page.
   • Download the installer for your operating system:
     • Windows: Download the .exe file.
     • MacOS: Download the .pkg file.
     • Linux: Use the system's package manager (e.g., apt, yum).

2. Run the installer

   • Check Add Python to PATH (important).
   • Select Install Now.

3. Restart your terminal after the installation.

---

Verify Installation

Ensure Python and pip are installed correctly.

python --version
pip --version

Expected output:

Python 3.10.0  # Example version
pip 23.1.2     # Example pip version

If you see "command not found", double-check if Python is installed and in your PATH.

---

Install SDK

Install the Python SDK via pip:

pip install styleysdk

This installs the Styley SDK and its dependencies.

---

Environment Variables

To authenticate API requests, set the following environment variable:

export X_STYLEY_KEY=***************************

---

Usage

This section covers available methods for interacting with deployments and models.

---

Deployments

📤 Create Deployment

The Create Deployment method allows you to create a new deployment using a model name and arguments. It returns an output with a job_id that you can use to fetch the final results.

Additional Parameters:

• output_format (str, optional): Output format for the result.

  • Images: png, jpg, jpeg, gif, bmp, tiff, webp, ico
  • Videos: mp4, webm, mkv, mov, avi

• output_width (int, optional): Output image width in pixels (positive integer)

• output_height (int, optional): Output image height in pixels (positive integer)

Note: For image resizing, both width and height must be specified together. If only one dimension is provided, the original image size will be maintained.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
deployment = styley.deployments.create(
    deployment=CreateDeployment(
        name="Virtual Staging Fast",
        model_id="fc5525a1-d073-4ee2-95f7-a6b9388aab94",
        args={              
            "image": "https://cdn.mediamagic.dev/media/c2310708-5b9d-11ef-b10b-30d042e69440.jpg",
            "remove_existing_furniture": "off",
            "room_type": "living",
            "style": "modern",
            "wait_for_completion": "false"
        },
        output_format="png",
        output_width=1024,
        output_height=1024,
    )
)
print("Deployment created successfully")
print(deployment)

---

📄 Get Deployment By ID

Fetch details of a specific deployment using its deployment ID.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
deployment_details = styley.deployments.get_by_id(deployment_id)
print(deployment_details)

---

📜 List Deployments

Retrieve a list of all deployments.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
deployments_list = styley.deployments.list()
print(deployments_list)

---

🚀 Get Deployment Job

Get the status of a deployment job using its job ID.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
job_status = styley.deployments.get_job(job_id)
print(job_status)

---

Models

📜 List Models

Retrieve a list of all models available for deployments.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
models_list = styley.models.list()
print(models_list)

---

🔍 Get Model By ID

Fetch a specific model’s details using its model ID.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
model_details = styley.models.get_by_id(model_id)
print(model_details)

---

🔍 Get Model By Name

Fetch a specific model’s details using its model name.

Example:

from styleysdk import Styley
from styleysdk.deployments.model import CreateDeployment
from styleysdk.deployments.model import Job

styley = Styley()
model_details = styley.models.get_by_name(model_name)
print(model_details)

---

Class & Method Reference

Class	Method	Description
Deployments	create(payload)	Create a new deployment.
Deployments	get_by_id(id)	Get deployment details by deployment ID.
Deployments	list()	List all deployments.
Deployments	get_job(job_id)	Get the status of a deployment job.
Models	list()	List all available models.
Models	get_by_id(id)	Get model details by model ID.
Models	get_by_name(name)	Get model details by model name.

---