Metadata-Version: 2.4
Name: pixy-sdk
Version: 0.0.1
Summary: A python sdk for pixy.
Author-email: Amirhossein Berenji <ahberenji@gmail.com>, Mahdi Kiani <mahdikiany@gmail.com>
Maintainer-email: Amirhossein Berenji <ahberenji@gmail.com>, Mahdi Kiani <mahdikiany@gmail.com>
Project-URL: Homepage, https://github.com/pixiee-ai/pixy-sdk
Project-URL: Bug Reports, https://github.com/pixiee-ai/pixy-sdk/issues
Project-URL: Funding, https://github.com/pixiee-ai/pixy-sdk
Project-URL: Say Thanks!, https://saythanks.io/to/mahdikiani
Project-URL: Source, https://github.com/pixiee-ai/pixy-sdk
Keywords: pixy,GenAI,Image Generation,Subtitle,Video Generation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: pydantic>=2
Requires-Dist: httpx

# Pixy Official PythonSDK

Pixy is a GenAI plform to generate multi-media resources. This SDK provides a super simple and integrated interface to generate images, videos and subtitles using the Pixy API.

## Installation

```bash
<span style="color:red">pip install pixy_sdk</span>
```

## Usage

This SDK can be used in two ways:

1. **Naive**: Conducting tasks using the `PixyClient` class; this way, operations are simple and straightforward, sacrificing flexibility.

2. **Advanced**: Methods of the `PixyClient` rely on a set of functions, available at the `utils` [module](core/utils); using these functions directly increases the flexibility, however this approach can get more complex.

## Documentation

For each module of the SDK, we have prepaired exlusive documentation pages, as below:

1. [`client`](documentation/client): This module provides the `PixyClient` class; if you are considering taking the Naive approach (as described above) to use the SDK, you should start here.

2. [`schemas`](documentation/schemas): To avoid data validation issues, we define and use custom data classes as schemas; on this page, we go through each of them individually.

3. [`utils`](documentation/utils): To provide advanced users with more control over the SDK, the whole functionality of the SDK is also available outside of the `PixyClient` class; on this page, we go through each of them individually.
