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.4.tar.gz (3.2 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.4-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: videojungle-0.1.4.tar.gz
  • Upload date:
  • Size: 3.2 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.4.tar.gz
Algorithm Hash digest
SHA256 cc6cd5f1b3508b2cac12a8257370f7d9c98969988a1020781940fd87c08ef4e2
MD5 420792d479eb4c1095188283c3367047
BLAKE2b-256 2b0515271e26f4ae6d7d283595b74f4af948d5b073dfcf67055fa23c7b4e4bfe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: videojungle-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 3.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d4f8cdf79212e294aee488a9c9951374143e44b6665adf9338fefa44402c500d
MD5 2ba6420b6dd336e22276460ab0e210fb
BLAKE2b-256 72308293f32e2641b5a7dfd658556ec5eb7787d3566ca10de1749b6f55512f63

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