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

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
  • musickit playlist — auto-generated .m3u8 mixes anchored to a seed track
  • Edge cases — every weirdness encountered on real rips
  • Roadmap — what's next
  • Development — directory layout + test patterns + commit style

Status

v0.6.2 · 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, index) and playlist carrying gen / list / show. 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.7.0.tar.gz (164.0 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.7.0-py3-none-any.whl (208.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: musickit-0.7.0.tar.gz
  • Upload date:
  • Size: 164.0 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.7.0.tar.gz
Algorithm Hash digest
SHA256 a79955725a11a4f37cf69551a094878705bd653dfd296bf262d1025bd05f31b2
MD5 bde78d314dc3af98651802365ea7aec4
BLAKE2b-256 8c0597fb5f55227f6e4e5f2aa714a48b7d24f8e483f3fe6610fc568fba63dea8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: musickit-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 208.4 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb1617eb328df72fc2d2b1033665fa91b5308a09cef45971f3095199cf16241e
MD5 a2115dcc650699887fdd89be7113f99c
BLAKE2b-256 5d3d37cb9b5275eec04120c1e0ddcdecbc7a21713f7c918fca47b13347139bfd

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