Documentation

Documentation for PyCaps is coming soon. In the meantime, here's a quick overview of how to get started.

Installation

pip install pycaps

Basic Usage

PyCaps can be used in three different ways: via CLI, JSON configuration, or directly in Python code.

CLI Usage

pycaps --input video.mp4 --output output.mp4 --template modern

JSON Configuration

Create a JSON file with your configuration:

{
"input": "video.mp4",
"output": "output.mp4",
"template": "modern",
"styles": {
  "word-being-narrated": {
    "color": "#ff5733",
    "font-weight": "bold"
  }
},
"tags": {
  "finance": {
    "color": "#33ff57"
  }
}
}

Then run:

pycaps --config my_config.json

Python Code

import pycaps

# Configure your API key (if using AI features)
pycaps.configure(api_key="your_api_key_here")

# Process a video
pycaps.process_video(
  input_path="video.mp4",
  output_path="output.mp4",
  template="modern",
  styles={
      "word-being-narrated": {
          "color": "#ff5733",
          "font-weight": "bold"
      }
  }
)

API Key Configuration

To use AI features like smart tagging and emoji suggestions, you'll need to configure your API key. You can get your API key from your dashboard.

CLI Configuration

pycaps config --api-key your_api_key_here

Python Configuration

pycaps.configure(api_key="your_api_key_here")