Skip to main content

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

  1. Install build tools: pip install build twine (or pip install ".[publish]").

  2. Create a PyPI account and an API token at pypi.org/manage/account/token/.

  3. 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 set TWINE_USERNAME=__token__ and TWINE_PASSWORD=pypi-your-token.

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

summscriber-0.2.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

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

summscriber-0.2.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file summscriber-0.2.0.tar.gz.

File metadata

  • Download URL: summscriber-0.2.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for summscriber-0.2.0.tar.gz
Algorithm Hash digest
SHA256 678382896b1122837fe5086601a9ef3ff3f9c3b7a759dee390a6889015ac42c6
MD5 6eeeb612810dae4725f0abf0259f81b9
BLAKE2b-256 58e9252d69a9fe230e88cf6c8778d9ab446bb6c7a0b5fda3d62d5e72fee7dd42

See more details on using hashes here.

File details

Details for the file summscriber-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: summscriber-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for summscriber-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffd03ee322da6e04194dda0ffcbf4955ab91322c471b285519aa45bb1e30c18d
MD5 7811d1a7449653c730a71e68258086d2
BLAKE2b-256 81907320557f9293e3671693f3ef9eaab165831468396badadfd126ddd8d5a04

See more details on using hashes here.

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