Skip to main content

A small faster-whisper command-line transcriber for local audio files.

Project description

speechscribe

A small command-line wrapper around faster-whisper for local audio transcription.

It packages your original script as a pip-installable command:

speechscribe audio.wav

Package name

This project is configured to publish as:

name = "speechscribe"

The installed command and import package are also speechscribe.

Install locally while testing

From this directory:

python3 -m pip install -e .
speechscribe --help

Usage

Transcribe with the default model (medium) and default compute type (int8):

speechscribe audio.wav

Use --input instead of the positional argument:

speechscribe --input audio.wav

Choose a model:

speechscribe audio.wav --model small
speechscribe audio.wav --model large-v3

Choose a compute type:

speechscribe audio.wav --compute-type float16

Write to a custom output file:

speechscribe audio.wav --output transcript.txt

Print timestamped segments as they are processed:

speechscribe audio.wav --verbose

Copy the finished transcript to the macOS clipboard with pbcopy:

speechscribe audio.wav --copy

Skip the delete-original prompt:

speechscribe audio.wav --nodelete

Use the DokuWiki output mode from the original script:

speechscribe audio.wav --format dokuwiki

By default, output is written beside the audio file as:

YYYY_MM_DD_inputfilename.txt

Publish to PyPI

This repository includes a helper script named pip-publish.

Recommended environment-variable token setup:

export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-your-token-here

Then run:

chmod +x pip-publish
./pip-publish

Optional TestPyPI run:

./pip-publish --testpypi

Dry run that builds and checks distributions without uploading:

./pip-publish --dry-run

The script will:

  1. install or upgrade build and twine, unless --no-install-deps is passed;
  2. clean previous dist/, build/, and *.egg-info output, unless --skip-clean is passed;
  3. build a source distribution and wheel;
  4. run twine check dist/*;
  5. upload with twine upload dist/*.

See docs/PUBLISHING.md for more options.

Notes

  • faster-whisper requires Python 3.9 or newer.
  • The first run may download the selected Whisper model.
  • The --copy option is intentionally macOS-focused because it uses pbcopy, matching the original script.

License

MIT

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

speechscribe-0.1.0.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

speechscribe-0.1.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: speechscribe-0.1.0.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for speechscribe-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d2712a4bdbe7bae006e2177d7005aa87b18714a5d9b3708b1c43da80f967e103
MD5 e04fb7b57b6675e58c304cc0da934a03
BLAKE2b-256 aa54c27fb83d2b616be3a6e1b4ea3455d781a00afdbfc161f5d791f6ec3b1144

See more details on using hashes here.

File details

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

File metadata

  • Download URL: speechscribe-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for speechscribe-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c189a686175b601c60a50c10a460899f7d014dd13ca939f824b61c65eb10ae75
MD5 341f0dd453f6d7597edc7f77630e7bf7
BLAKE2b-256 32f9e1af8bad5e609cc19b32183c9ad99eaf53279fd4c0d7db62914fd7471f4c

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