Skip to main content

Simple audiobook player

Project description

Audiobook Player

PyPI Changelog Tests License

A simple, cross-platform command-line audiobook player.

Features

  • Cross-platform: Works on macOS and Raspberry Pi (Linux).
  • Natural Sorting: Chapters are sorted naturally (e.g., "chapter 2.mp3" comes before "chapter 10.mp3").
  • Live Controls: Control playback with keyboard shortcuts (next, previous, stop, quit).
  • Progress Saving: Automatically saves your progress and resumes from where you left off.
  • Modular Backend: The media player backend is pluggable, making it easy to add support for other platforms.

Supported Platforms

  • macOS: Uses afplay for audio playback.
  • Raspberry Pi (Linux): Uses omxplayer for audio playback.

Installation

Install this tool using pip:

pip install audiobook-player

Usage

To start playing an audiobook, simply point the player to the folder containing your MP3 files:

aplayer /path/to/your/audiobook

If you don't provide a folder path, you will be prompted to enter one.

Controls

Once the audiobook is playing, you can use the following keyboard shortcuts to control playback:

  • n: Go to the next chapter.
  • p: Go to the previous chapter.
  • s: Stop playback and save your progress.
  • q: Quit the player (your progress will be saved).
  • ?: Display the controls.

Development

To contribute to this tool, first check out the code. Then create a new virtual environment:

cd audiobook-player
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

python -m pytest

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

audiobook_player-0.0.1.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

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

audiobook_player-0.0.1-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file audiobook_player-0.0.1.tar.gz.

File metadata

  • Download URL: audiobook_player-0.0.1.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for audiobook_player-0.0.1.tar.gz
Algorithm Hash digest
SHA256 f06d98b7df5446be147936f2c26c25d914d0a17fe442ca9409a2417e84245612
MD5 a79ca5f8a11f49c70852cdcc7c281181
BLAKE2b-256 848b15120dea2046dbb6a998fd77fb0160b7910befd00d290c5b60d3fc7d8c05

See more details on using hashes here.

Provenance

The following attestation bundles were made for audiobook_player-0.0.1.tar.gz:

Publisher: publish.yml on sukhbinder/audiobook-player

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file audiobook_player-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for audiobook_player-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a35eb1a2b85817edf08849a77e0e87294feb6d3b6770be48d1c288f24a8dd57
MD5 9e4a2163f0eaff5ef2756507bb4e93b2
BLAKE2b-256 45b7e968b6790f9fa7cdb61b34fb397cfa1b6288f8cfd0513970f9095f4491ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for audiobook_player-0.0.1-py3-none-any.whl:

Publisher: publish.yml on sukhbinder/audiobook-player

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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