Skip to main content

Generate video tutorials from automated tests using LLMs

Project description

Codevid

Codevid Logo

Turn your automated tests into professional video tutorials.

Codevid is a CLI tool that uses AI to convert your existing Python Playwright tests into narrated, captioned video tutorials. It analyzes your test code, generates a natural language script, records the execution, and automatically edits everything into a polished video.

🎬 How It Works

demo2.webm

Generated Tutorial

Here's the result - a fully narrated video tutorial generated from the test above:

https://github.com/user-attachments/assets/de1d647b-527b-4c66-a46b-7b86247c345c

🚀 Features

  • Automated Scriptwriting: Uses LLMs (OpenAI/Anthropic) to explain why an action is happening, not just what is happening.
  • Real Execution: Records your actual app in a browser to ensure the video matches reality.
  • AI Voiceovers: Integrated Text-to-Speech (OpenAI/Edge TTS) for professional narration.
  • Smart Editing: Automatically synchronizes video speed with audio narration and adds captions.
  • Stable Sync: Keeps narration aligned even when multiple narration segments map to one test step.

📋 Prerequisites

  • Python 3.11+
  • OpenAI API Key: Codevid requires access to an LLM to generate the narration script.

🛠️ Installation

  1. Install Codevid (assuming it is available via pip or from source):

    pip install codevid
    
  2. Install Playwright Browsers:

    playwright install chromium
    

🔑 Configuration

You must provide your OpenAI API key for the tool to function.

export OPENAI_API_KEY="sk-..."

(Alternatively, you can configure Anthropic/Claude keys if you prefer that provider in the config).

⚡ Quick Start

  1. Initialize a project (optional, creates a codevid.yaml config file):

    codevid init
    
  2. Generate a video: Pass your Playwright test file to the generate command.

    codevid generate examples/test_login.py -o login_tutorial.mp4
    

📖 Usage Examples

Basic Generation

Uses default settings (Anthropic/Edge TTS if not configured otherwise) to generate a video.

codevid generate tests/my_test.py

Using OpenAI for Everything

Specify the LLM and TTS provider explicitly via CLI flags.

codevid generate tests/my_test.py \
    --llm openai \
    --tts openai \
    --voice alloy \
    --output tutorial.mp4

Preview Script Only

Want to see what the AI will say before recording? Use preview mode.

codevid preview tests/my_test.py

List Available Voices

See which voices are available for your chosen provider.

codevid list-voices openai

⚠️ Current Limitations

  • Framework Support: Currently, Codevid only supports Python Playwright tests.
  • Structure: Tests must be written as standard functions or Pytest functions (e.g., def test_example(page):).

📄 License

MIT

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

codevid-1.3.0.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

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

codevid-1.3.0-py3-none-any.whl (61.3 kB view details)

Uploaded Python 3

File details

Details for the file codevid-1.3.0.tar.gz.

File metadata

  • Download URL: codevid-1.3.0.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codevid-1.3.0.tar.gz
Algorithm Hash digest
SHA256 bf6334e96358d09dcfab9ad295c7416a12f82527bb0d9048b9203f1449382a46
MD5 96aad98cd01611e379ce89b6b78fa2d1
BLAKE2b-256 fd59053924dcc3f25259a010e615ccf23d67bb0b3f2ff28b36b821f5458d2255

See more details on using hashes here.

Provenance

The following attestation bundles were made for codevid-1.3.0.tar.gz:

Publisher: release.yml on MStaniaszek1998/codevid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codevid-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: codevid-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 61.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codevid-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8f39083afedecb06629ce7900678a94efc71dbceea2c379ff17947848c166e0
MD5 a5501596302a70b237993c41b8c70639
BLAKE2b-256 4722c4d5034f5786b233058324e5e271729bbd4a0703d2de05f1babe1a3d6abd

See more details on using hashes here.

Provenance

The following attestation bundles were made for codevid-1.3.0-py3-none-any.whl:

Publisher: release.yml on MStaniaszek1998/codevid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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