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.6.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.6-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: videojungle-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 d861f0da4635cde8239e553eb850f27bf0ebd8cf12cf601830639a695ce51de2
MD5 3e6acd58c5a3f271776c63aa05819b0d
BLAKE2b-256 a374f88d4a7b2319596f9b959e271791b7b0e6b200d42d338980a1d120fbd1da

See more details on using hashes here.

File details

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

File metadata

  • Download URL: videojungle-0.1.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d0b55e842ff581a35b06ae6d5c9d124f7ecb7f5b4128ab96e3b3363c78b5be97
MD5 acaf02fbc8aa66bd8087de970c5d49ed
BLAKE2b-256 c1925a5e5f8f607ee5985772993021121df42c09b6c56fe0a6d0ffe24b380574

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