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.1.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.1.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: summscriber-0.1.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.1.0.tar.gz
Algorithm Hash digest
SHA256 d441f98cffd205ba758bec55afa52be387aaa23ae093bca3dd3162ca59b9ab8d
MD5 d5f04471e686d88a9b0aaf5c4cea8cfe
BLAKE2b-256 ff8cd9287e3942dd2405e034ddc3431a0edb13370c12e4701760ce82c7eb24d2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: summscriber-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fc03cbe7f79fcde41d0e5c09b4c24837a53d8b6207f5e48f45273d052b8c2fe0
MD5 df15f87ee3c3dfb3259886f0cb74bd08
BLAKE2b-256 1238d00ea10450e165b4d8c058b49be0b7168e9cbabde7ae1f9e54305ad58d4e

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