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.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)

# Get the video file ID from the generated video
asset_id = video.assets_id

# Save the video file to disk
video_file = vj.assets.download(asset_id, "generated_horoscope.mp4")

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

videojungle-0.1.11-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: videojungle-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 4.7 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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a5fed6519b3ed26f1885241cc37a945498f50ab9b11dec96277956d8050e89
MD5 b7d218b0432ecb835961ae05b0656220
BLAKE2b-256 20ffdae36524fcf08a77815308c6908be6b660cd5cc0859ab3ba8319766139f2

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