Metadata-Version: 2.1
Name: videojungle
Version: 0.1.2
Summary: A Python client for the Video Jungle API
Project-URL: repository, https://github.com/burningion/video-jungle-python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: requests

# Video Jungle API Client

This is a Python client for the Video Jungle API. It provides a simple interface to interact with the Video Jungle API.

## Installation

You can install the Video Jungle API client using pip:

```
pip install videojungle
```

## Usage

Here's a simple example of how to use the Video Jungle API client:

```python
from videojungle import ApiClient
import os

# Assumes you've set your API key as an environment variable
VJ_API_KEY = os.environ['VJ_API_KEY']

# Initialize API client
vj = ApiClient(token=VJ_API_KEY)

# Define your video generation task, along with variables to pass on generation
prompt = vj.prompts.generate(task="a horoscope reader who wants to leave the person excited about their future",
                            parameters=["zodiac sign", "lucky number", "lucky color"])


# Create a project to hold generated files, using our prompt we've generated
project = vj.projects.create(name="First Project", 
                             description="My first project", 
                             prompt_id=prompt["id"])

# Get a script for the generation process
script_id = project["script"]["id"]

# Generate a video from our created prompt with dynamic variables
video = project.generate(script_id=script_id, 
                             project_id=project["id"],
                             parameters={"zodiac sign": "Aries",
                                        "lucky number": "7",
                                        "lucky color": "green"})
print(video)
```

This example lives in the `examples/` folder.

## License

This project is licensed under the MIT License.
