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
uvx musickit playlist gen ./output --seed <track> --minutes 60 # auto-generate a mix

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

The bundled browser UI tracks the same visual language — bordered panels with floating titles, same palette and KeyBar:

Browser UI — drilled into an album

Internet radio mode (Stations panel + ICY metadata in the title):

Browser UI — radio mode

More screenshots in the TUI guide and serve 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
  • musickit playlist — auto-generated .m3u8 mixes anchored to a seed track
  • Desktop apps — Tauri + Electron generic Subsonic clients
  • Mobile (Subsonic) — play:Sub / Amperfy / Symfonium / DSub / Tempo
  • Edge cases — every weirdness encountered on real rips
  • Roadmap — what's next
  • Development — directory layout + test patterns + commit style

Status

v0.13.0 · browser UI tracks the TUI's visual language (bordered panels, palette, keybinds for repeat / shuffle / volume / seek, slide-in help, command palette via Cmd/Ctrl+P, internet radio via the existing radio.toml) — ruff + mypy + pyright clean, full pytest suite green. Six top-level commands — convert, library, inspect, tui, serve, playlist — with library carrying the read / mutate / manage subcommands (tree, audit, fix, cover, cover-pick, retag, lyrics, index) and playlist carrying gen / list / show. The TUI ships local-library playback, internet radio, Subsonic-client mode (with persistent token-auth credentials), AirPlay output (incl. pause + volume routing), mDNS discovery, ReplayGain normalisation, a diacritic-folded /-filter, in-place tag editing (e for track / album-wide), auto-generated Mixes (g to create, browseable view of saved .m3u8), a 48-band FFT visualiser with f / v toggles, synced lyrics via l (parsed [mm:ss.xx] markers, active line bolded as playback advances), 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), backs heart / star buttons with a persistent <root>/.musickit/stars.toml, returns sub-ms FTS5-ranked /search3 results, promotes LRC lyrics to synced: true, and is 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


Release history Release notifications | RSS feed

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.13.8.tar.gz (231.2 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.13.8-py3-none-any.whl (288.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: musickit-0.13.8.tar.gz
  • Upload date:
  • Size: 231.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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.13.8.tar.gz
Algorithm Hash digest
SHA256 5203047a6f1a92aaf21a094fc60e181b0d324d9dd1f69428c86fc50e7e241e24
MD5 120740a440025e73c899bc922eda5c00
BLAKE2b-256 e8e5cf9ecca1872797d655478f6c778ab338429d197b28819e0e8e4b93ed02cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: musickit-0.13.8-py3-none-any.whl
  • Upload date:
  • Size: 288.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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.13.8-py3-none-any.whl
Algorithm Hash digest
SHA256 413ac03929e86fb8f4fdde53e7ef1cfc56a29bed695e6101b9bc093315a78775
MD5 31da13d6fc96f7715234a90418a99ab7
BLAKE2b-256 966d57cbf32d270561b5c0eb3eacedf474ff5cdb5560432acd984a1498a9bbef

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