Metadata-Version: 2.4
Name: videodocgen
Version: 0.1.0
Summary: Convert demo videos into structured documentation, locally.
Project-URL: Homepage, https://github.com/vocso/videodocgen
Project-URL: Issues, https://github.com/vocso/videodocgen/issues
Author-email: Deepak Chauhan <deepak@vocso.com>
License: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.12
Requires-Dist: imagehash>=4.3
Requires-Dist: jinja2>=3.1
Requires-Dist: opencv-python-headless>=4.9
Requires-Dist: pillow>=10
Requires-Dist: pydantic-settings>=2
Requires-Dist: pydantic>=2
Requires-Dist: pytesseract>=0.3.10
Requires-Dist: pyyaml>=6
Requires-Dist: scenedetect>=0.6.4
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

# VideoDocGen

Convert demo/screen-recording videos into structured documentation — a
Markdown "User Guide", extracted screenshots, and a structured
`document.json` — using only local, pip-installable dependencies.

> An open-source project by [**VOCSO Technologies Pvt. Ltd.**](https://vocso.com) ·
> Maintained by [Deepak Chauhan](https://github.com/vocso-com) ·
> [github.com/vocso-com/videodocgen](https://github.com/vocso-com/videodocgen)

## Guarantees

- **Local only.** No cloud APIs, no API keys, no model downloads, no network
  calls at runtime.
- **Deterministic & reproducible.** Same input + config produce the same
  output. Runnable in CI.
- **Extensible by design.** OCR, understanding, rendering, and export are
  provider interfaces selected by config, so new implementations (cloud AI,
  additional OCR engines, more output formats) slot in without rework. See
  [ARCHITECTURE.md](ARCHITECTURE.md).

## Installation

VideoDocGen needs **Python 3.12+** and two command-line tools on your `PATH`:
[FFmpeg](https://ffmpeg.org/) (`ffmpeg` + `ffprobe`, for video decode and
screenshot extraction) and [Tesseract OCR](https://github.com/tesseract-ocr/tesseract)
(`tesseract`, for reading on-screen text).

### 1. Install the system tools

```bash
# macOS (Homebrew)
brew install ffmpeg tesseract
```
```bash
# Debian / Ubuntu
sudo apt-get update && sudo apt-get install -y ffmpeg tesseract-ocr
```
```bash
# Windows (winget)
winget install Gyan.FFmpeg UB-Mannheim.TesseractOCR
```

### 2. Install VideoDocGen

> Not yet on PyPI — install from source. (`pip install videodocgen` is coming
> once the release workflow lands.)

```bash
git clone https://github.com/vocso-com/videodocgen.git
cd videodocgen
python3.12 -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
pip install -e .
```

Use `pip install -e ".[dev]"` instead if you plan to run the tests or contribute
(see [Development](#development)).

### 3. Verify your setup

```bash
videodocgen doctor
```

This checks that FFmpeg, ffprobe, Tesseract, OpenCV, and PySceneDetect are all
available and prints a ✓/✗ for each. Fix anything marked ✗ before running.

## Quickstart

```bash
videodocgen run input.mp4
```

This runs the full pipeline against `input.mp4` and writes a Markdown user
guide, extracted screenshots, and `document.json` to the output directory
(default `docs/`).

Other commands:

```bash
videodocgen batch DIR          # process every video in a directory
videodocgen config             # print the resolved effective configuration
videodocgen doctor             # verify FFmpeg/Tesseract/OpenCV are available
```

Run `videodocgen doctor` first if you're unsure whether your environment has
the required system dependencies installed.

## Development

```bash
pip install -e ".[dev]"
pre-commit install
ruff check .
black --check .
pytest
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for the full workflow and
[ARCHITECTURE.md](ARCHITECTURE.md) for the module layout.

## About VOCSO

VideoDocGen is developed and maintained by
[VOCSO Technologies Pvt. Ltd.](https://vocso.com), a software and design studio.
We build it in the open so teams everywhere can turn product demos into
documentation without manual screenshotting and writing.

GitHub org: [@vocso-com](https://github.com/vocso-com) · Maintainer: Deepak Chauhan.
Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md).

## License

[MIT](LICENSE) &copy; VOCSO Technologies Pvt. Ltd.
