initial commit

Author: amirberenji1995

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+# this file is *not* meant to cover or endorse the use of GitHub Actions, but rather to
+# help make automated releases for this project
+
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    - name: Install build dependencies
+      run: python -m pip install -U setuptools wheel build
+    - name: Build
+      run: python -m build .
+    - name: Publish
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        skip-existing: true
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,4 @@
+__pycache__
+.pytest_cache
+.env
+core/__pycache__

README.md

@@ -0,0 +1,27 @@
+# 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.