Metadata-Version: 2.4
Name: auto-subs
Version: 0.1.0
Summary: A powerful, local-first library and CLI for video transcription and subtitle generation using Whisper.
Project-URL: Homepage, https://github.com/mateusz-kow/auto-subs
Project-URL: Repository, https://github.com/mateusz-kow/auto-subs
Author-email: Mateusz Kowalski <kowalski.mateusz.1lo1@gmail.com>
License: Copyright 2025 Mateusz Kowalski
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Text Processing
Requires-Python: >=3.11
Requires-Dist: pydantic~=2.12.0
Requires-Dist: typer~=0.19.2
Provides-Extra: dev
Requires-Dist: pre-commit~=4.3.0; extra == 'dev'
Requires-Dist: pyright~=1.1.406; extra == 'dev'
Requires-Dist: pytest-cov~=7.0.0; extra == 'dev'
Requires-Dist: pytest~=8.4.2; extra == 'dev'
Requires-Dist: ruff~=0.14.0; extra == 'dev'
Description-Content-Type: text/markdown

# Auto-Subs

**A powerful, local-first library and CLI for video transcription and subtitle generation using Whisper.**

This project is currently in early development.

## Installation

```bash
pip install auto-subs
```

## Usage (CLI)

Get the application version:
```bash
auto-subs --version
```

Generate subtitles from a Whisper JSON output:
```bash
auto-subs generate path/to/transcription.json
```

### Options

- `--output, -o`: Specify the output file path. (Defaults to the same name as the input file)
- `--format, -f`: Choose the output format (`srt`, `ass`, `txt`). (Defaults to `srt`)
- `--max-chars`: Set the maximum characters per subtitle line. (Defaults to `35`)

Example with options:
```bash
auto-subs generate input.json -o subtitles.ass -f ass --max-chars 40
```

### Outputs

The CLI can generate subtitles in the following formats:
- **SRT (.srt)**: The most common subtitle format, compatible with most video players.
- **ASS (.ass)**: Advanced SubStation Alpha, allowing for rich styling (word-level highlighting coming soon).
- **Text (.txt)**: A plain text transcript.

---
*This project is maintained by [Mateusz Kowalski](https://github.com/mateusz-kow).*
