Transcribe audio with Whisper (faster-whisper), with summarization (pysummarization, sumy, OpenAI) and short reply with OpenAI.
Project description
Summscriber
Transcribe audio with faster-whisper (Whisper), with summarization options (pysummarization, sumy, OpenAI) and short reply generation via OpenAI API.
Repository: github.com/pablogventura/summscriber
Installation
With pipx (recommended: isolated env, global command)
pipx install git+https://github.com/pablogventura/summscriber.git
To upgrade:
pipx upgrade summscriber
With pip (from project directory)
pip install .
Or in editable mode (development):
pip install -e .
Or from the repository:
pip install git+https://github.com/pablogventura/summscriber.git
Or from PyPI (once published):
pip install summscriber
Usage
After installing, the summscriber command is available:
summscriber FILE [options]
Examples:
summscriber recording.mp3
summscriber interview.ogg --summary
summscriber audio.wav --summary --reply --json
Main options
- FILE: audio file to transcribe (required).
--summary: summarize (OpenAI if token works; otherwise shortest of pysummarization and sumy).--summary-pysummarization/--summary-sumy/--summary-openai: use a specific summarization backend.--summary-sentences N: number of sentences in the summary (default 3).--reply: generate a short reply to the message with OpenAI.--json: output as JSON.
For summarization and reply with OpenAI, use config.ini (section [openai]) or environment variables OPENAI_API_KEY and optionally OPENAI_BASE_URL. See config.ini.example. You can save your token and URL with:
summscriber --save-config --api-key YOUR_TOKEN --base-url https://...
Development
From the repo root without installing:
python -m summscriber FILE [options]
Publishing to PyPI
-
Install build tools:
pip install build twine(orpip install ".[publish]"). -
Create a PyPI account and an API token at pypi.org/manage/account/token/.
-
From the project root run:
./publish.sh
Or manually:
rm -rf build dist *.egg-info python -m build twine upload dist/*
When prompted, use username
__token__and password your PyPI token. Or setTWINE_USERNAME=__token__andTWINE_PASSWORD=pypi-your-token.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file summscriber-0.3.0.tar.gz.
File metadata
- Download URL: summscriber-0.3.0.tar.gz
- Upload date:
- Size: 20.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d62693770a3f90a899c636299d08c1e6ccb043d1d95aa6d287c44aa5358d100a
|
|
| MD5 |
cb258b07725132ce53dc8d24e170640f
|
|
| BLAKE2b-256 |
339af65c091e988de60571fce5f6ae8665a8743b283cb716bfce0ae11212711c
|
File details
Details for the file summscriber-0.3.0-py3-none-any.whl.
File metadata
- Download URL: summscriber-0.3.0-py3-none-any.whl
- Upload date:
- Size: 19.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ddfe2100dfe15ac5d1d7c20804728505ac516162290a9319c75a6ad2e915975d
|
|
| MD5 |
97edccbeb8885e3be524b9860ad34271
|
|
| BLAKE2b-256 |
b273cf33e45a9807e136e2969bc5979a26d83427dce8d9fbf436d1699655336a
|