Skip to main content

A Python client for the Video Jungle API

Project description

Video Jungle API Client

This is a Python client for the Video Jungle API.

Video Jungle is a generative video creator. It allows you to generate custom videos via dynamic variables.

Let's say you want to generate daily astrology readings according to your user's astrological sign, lucky number, and lucky color.

Video Jungle allows you to pass in a value for each, and generate a unique video for that specific user.

See below for an example of how to build a generative video workflow using the 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 for the Horoscope example:

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 first script for the generation process
script = vj.scripts.list(project["script"]["id"])[0]
script_id = script["id"]

# Print out parameters required for generation
print(project["prompts"][0]["parameters"])

# Generate a video from our created prompt with dynamic variables
video = vj.projects.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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

videojungle-0.1.5.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

videojungle-0.1.5-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file videojungle-0.1.5.tar.gz.

File metadata

  • Download URL: videojungle-0.1.5.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for videojungle-0.1.5.tar.gz
Algorithm Hash digest
SHA256 dfc0aa1dd2bce1dbf23f7c027276e479ad147ea80dcc9a9bf987252ca8af6304
MD5 a53b3f1a0d33f787130745242bc1c7dd
BLAKE2b-256 280b08128bd881b97a03de37c6adbe0449844db05905d5a1cb1564529ba2a8ee

See more details on using hashes here.

File details

Details for the file videojungle-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: videojungle-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for videojungle-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 797f4bd61ece88c9b9f13fe6a28c31b3bfb16be0596fda04b6e8aae9dbeb5d21
MD5 864e489428be3219dc5bfdbfd0c8f410
BLAKE2b-256 bbed82b6b6f550d69a6941d5ee17141b76e3bc80cf49735f9d21e4d9df558954

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page