Skip to main content

Self-hosted music toolkit: convert / audit / retag rips into a clean tagged library, browse + play via a Textual TUI (local / internet radio / Subsonic-client / AirPlay), and stream over Tailscale via a Subsonic-compatible HTTP server.

Project description

musickit

CI PyPI version Python 3.13+ License: MIT Documentation

Python 3.13 CLI for converting audio rips into a clean tagged library, browsing and playing it via a Textual TUI, and streaming it over Tailscale via a Subsonic-compatible HTTP server.

Install

The lowest-friction way is uvx — it downloads, caches, and runs the latest published musickit in one step. No install step required:

uvx musickit --help

For daily / persistent use (PATH-installed, no per-run network check):

uv tool install musickit
musickit --help

You'll also need ffmpeg and ffprobe on $PATH for the convert pipeline:

brew install ffmpeg            # macOS
sudo apt install ffmpeg        # Debian / Ubuntu

Quickstart

uvx musickit convert ./input ./output       # convert
uvx musickit library audit ./output         # audit
uvx musickit tui ./output                   # TUI
uvx musickit serve ./output                 # Subsonic server

Screenshots

The TUI: artist browser on the left, drilled into an album, 48-band visualizer at the top.

Drilled-in album view

Fullscreen visualizer (f):

Fullscreen visualizer

More screenshots in the TUI guide.

Documentation

Full docs are at docs/ — built with MkDocs Material. Run them locally:

make docs-serve     # http://127.0.0.1:8000

Or jump straight to:

  • Architecture — how all the pieces fit together (process model, data flow, audio subprocess, SQLite index, FFT visualizer)
  • Quickstart — end-to-end walkthrough including iPhone + Tailscale + Amperfy
  • musickit convert — codec / bitrate / enrichment matrix
  • musickit library — audit rules + auto-fix + SQLite index
  • musickit tui — TUI: local + radio + Subsonic-client + AirPlay
  • musickit serve — Subsonic API + Tailscale + clients
  • Edge cases — every weirdness encountered on real rips
  • Roadmap — what's next
  • Development — directory layout + test patterns + commit style

Status

v0.5.0 · ruff + mypy + pyright clean, full pytest suite green. Five top-level commands — convert, library, inspect, tui, serve — with library carrying the read / mutate / manage subcommands (tree, audit, fix, cover, cover-pick, retag, index). The TUI ships local-library playback, internet radio, Subsonic-client mode, AirPlay output (incl. pause + volume routing), mDNS discovery, ReplayGain normalisation, an incremental /-filter, in-place tag editing (e for track / album-wide), a 48-band FFT visualiser, and click-to-seek on the progress bar. Audio decoder + sounddevice callback run in a separate process so UI work in the main interpreter can't stall playback. The server is OpenSubsonic-compatible (multipleGenres, transcodeOffset, songLyrics extensions) and tested against Symfonium / Amperfy / play:Sub / Feishin clients on iOS / Android / desktop. A persistent SQLite library index at <root>/.musickit/index.db makes cold starts skip the filesystem walk + tag read; the filesystem watcher does per-album incremental rescans.

License

See LICENSE in the repo root.

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

musickit-0.6.1.tar.gz (159.3 kB view details)

Uploaded Source

Built Distribution

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

musickit-0.6.1-py3-none-any.whl (203.1 kB view details)

Uploaded Python 3

File details

Details for the file musickit-0.6.1.tar.gz.

File metadata

  • Download URL: musickit-0.6.1.tar.gz
  • Upload date:
  • Size: 159.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for musickit-0.6.1.tar.gz
Algorithm Hash digest
SHA256 5ea81af47117aba6139ef107caeceef2b3b6de2b5c48891abc13a90d5cff34d8
MD5 b64ea4e2b050b2e1f8c4c64eecc60212
BLAKE2b-256 66f0aa9d9d4e9754527f86dc7f68a13f551b3ec7b90b5d323fa613d34f7b2dcb

See more details on using hashes here.

File details

Details for the file musickit-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: musickit-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 203.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for musickit-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0eb9146735427a252d63dfc428ea49191944e225bd639398b05058720b8d7248
MD5 ba5e66de99146610b87deb635a780393
BLAKE2b-256 1823e22c53b50ed5ec35448f1711ef7b31df6d85edc38b7bba267950bd083b86

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