Metadata-Version: 2.1
Name: echoscript
Version: 0.0.1
Summary: A audio-to-text conversion package
Author-email: Your Name <your.email@example.com>
Project-URL: Homepage, https://github.com/susuky/echoscript
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: coverage; extra == "test"

# echoscript

echoscript is an audio transcription tool based on the Whisper model, providing a simple and user-friendly command-line interface (CLI) for audio transcription tasks.

## Features

- Audio transcription: Convert audio files to text
- Support for multiple Whisper models
- Multiple output formats (plain text, JSON, SRT)
- Multi-language transcription support
- Command-line interface (CLI) operation
- Web application interface

## Installation

```bash
pip install echoscript
```

## Usage

### Basic Usage

```bash
echoscript -a path/to/audio/file.mp3
```

### Advanced Options

```bash
echoscript -a path/to/audio/file.mp3 -m medium -f srt -l en -o output.srt -v
```

- `-a`, `--audio`: Path to the audio file for transcription
- `-m`, `--model-name`: Name of the Whisper model to use (default is 'base')
- `-f`, `--fmt`: Output format, supports `json`, `srt`, or None (plain text)
- `-l`, `--language`: Language of the audio
- `-o`, `--filename`: Output filename
- `-v`, `--verbose`: Verbose mode, outputs transcription result to console

### List Available Models and Languages

```bash
echoscript list --models
echoscript list --languages
```

### Serve a Web Application

```bash
echoscript serve
echoscript serve --port 7860 --server_name 0.0.0.0 --share2pub
```

- `--port`: Specify the port for the web application (default is 7860)
- `--server_name`: Specify the server name (default is '0.0.0.0')
- `--share2pub/--no-share2pub`: Whether to share publicly (default is False)

## Development Plans

Future features planned:

- Speaker Diarization
- Additional audio processing and analysis features

## License

[MIT License](LICENSE)
