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.

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

📋 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.0.3.tar.gz (209.7 kB view details)

Uploaded Source

Built Distribution

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

codevid-1.0.3-py3-none-any.whl (52.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for codevid-1.0.3.tar.gz
Algorithm Hash digest
SHA256 d1366b21979e5c00eabbc4aaa07884350e0dc21d1135c8616ab83ed86bd29fac
MD5 f73cb6710e175b839e64e28e61d38243
BLAKE2b-256 921fd66eb265c917b98ab14acd90ec76ae223e024759ec46ca1df8980a2c756b

See more details on using hashes here.

Provenance

The following attestation bundles were made for codevid-1.0.3.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.0.3-py3-none-any.whl.

File metadata

  • Download URL: codevid-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 52.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.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 acb6552540f9b9127773df0c27726a9272988a1d84f329dca7a4c77ca6f5b489
MD5 68bbcab38762a1181d94c0105350edfa
BLAKE2b-256 03b6b43ff3102cc37dde2f9f97297f305b08b5fdb72155b86744120a9eff7dc7

See more details on using hashes here.

Provenance

The following attestation bundles were made for codevid-1.0.3-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