pykara 0.1

Karaoke effect templating engine for ASS subtitle files.

Pykara Templater

Pykara is a karaoke templating framework written in Python, inspired by the legacy Karaoke Templater from Aegisub.

Requirements

• Python 3.14 or higher

Installation

pip install pykara

Usage

pykara input.ass output.ass
pykara input.ass output.ass --json output.json   # Export intermediate data
pykara input.ass output.ass --warn-only          # Downgrade errors to warnings
pykara input.ass output.ass --seed 42            # Initial deterministic RNG seed
pykara input.ass output.ass --font-dir ./fonts   # Prefer fonts from a directory
pykara input.ass output.ass --generated-only     # Write only generated fx lines

See the documentation for the full reference.

Development

Create and activate a virtual environment:

python -m venv .venv
source .venv/bin/activate

Install development dependencies:

pip install -e ".[dev]"

Code Quality & Testing

mdformat --check .                 # Validate Markdown formatting
ruff check pykara tests            # Run lint rules
ruff format --check pykara tests   # Verify Python formatting
pyright                            # Run static type checking
pytest --cov                       # Run test suite with coverage

License

Distributed under the MIT License.