Skip to main content

A Python package for generating videos from JSON specifications

Project description

VidKit

A simple and powerful Python package for generating videos from JSON configurations. VidKit makes it easy to create videos by combining images, setting durations, and adding audio tracks.

Installation

pip install vidkit

Quick Start

from vidkit import renderVideo

# Define your video configuration
config = {
    "name": "my_video",
    "format": "mp4",
    "fps": 30,
    "resolution": {
        "width": 1920,
        "height": 1080
    },
    "frames": [
        {
            "image": "frame1.jpg",
            "duration": 5
        },
        {
            "image": "frame2.jpg",
            "duration": 5
        }
    ],
    "audio": "background.mp3"
}

# Generate the video
video = renderVideo(config)

# Save to file
with open("output.mp4", "wb") as f:
    f.write(video)

Features

  • Simple JSON-based configuration
  • Support for multiple image frames
  • Audio track integration
  • Fast video generation using moviepy
  • Flexible resolution settings
  • Configurable frame rates

Configuration Options

The video configuration accepts the following parameters:

Parameter Type Description Required
name string Name of the video Yes
format string Output format (currently 'mp4') Yes
framerate number Frame rate in FPS Yes
resolution [width, height] Video dimensions in pixels Yes
frames array List of frame objects Yes
audio string Path to audio file No

Frame Object Properties

Property Type Description Required
image string Path to image file Yes
duration number Duration in seconds Yes

Requirements

  • Python >= 3.6
  • moviepy >= 2.0.0
  • Pillow >= 9.2.0
  • numpy >= 1.25.0

Contributing

Contributions are welcome! Feel free to:

  1. Fork the repository
  2. Create a feature branch
  3. Submit a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Created by Carter Stach (@SpyC0der77)

Support

If you encounter any issues or have questions, please open an issue on GitHub.

Project details


Download files

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

Source Distribution

vidkit-0.1.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

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

vidkit-0.1.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file vidkit-0.1.0.tar.gz.

File metadata

  • Download URL: vidkit-0.1.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for vidkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 855e3db5b2bded0a416edcc2ad7f0171f97f5d2e43f0da006026870cb12b2996
MD5 6c02c069a16ae79db01c9dfa2056532c
BLAKE2b-256 d89c8b9b78758dafdf502961521214df0599f6429a4cb7ba2b66ea7b2b7e7344

See more details on using hashes here.

File details

Details for the file vidkit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vidkit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for vidkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f538639ded2433efe8e53a8ec2cc816522eef192514a1e66be2f5066c6c6a883
MD5 72278eefe46dcb88dc6735fa97e83b16
BLAKE2b-256 d355c2dcdfe34997f21d32a7077f4fe33c28b72944979c4d39cc5aea0da3adba

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