rytmuz 0.2.0

A kid-friendly YouTube music player for the terminal

RYTMUZ

A kid-friendly YouTube music player built with Python, Textualize, yt-dlp, and mpv.

Features

• Music-only focus: Audio playback only, no video distractions
• Easy search: Always-available search field with Ctrl+S hotkey
• Recent songs: Quick access to recently played songs with Ctrl+R
• Simple controls: Play/pause, seek ±10s, volume adjustment
• Smart caching: Fast replay of recent songs
• Visual feedback: Thumbnails displayed with terminal graphics
• Kid-friendly: Safe search enabled, focused on music discovery

Requirements

• Python 3.10+
• yt-dlp command-line tool (does all the heavy lifting for YouTube integration)
• mpv media player

Setup

1. Install system dependencies:

   # Ubuntu/Debian
   sudo apt install yt-dlp mpv
   
   # macOS
   brew install yt-dlp mpv
   

2. Run the app:

   # Using uvx (recommended - no installation needed)
   uvx rytmuz
   
   # Or using pipx
   pipx run rytmuz
   
   # Or install with pipx for persistent use
   pipx install rytmuz
   rytmuz
   

Optional: Improve Search Results with YouTube API

By default, rytmuz uses yt-dlp for searching, which provides basic keyword-based results. For better music-specific filtering (using YouTube's music topic and category filters), you can set up a free YouTube Data API v3 key:

Benefits

• Music-focused results: Filters to music content using YouTube's music category
• Better relevance: Uses YouTube's content categorization, not just keywords
• Safer for kids: More predictable, music-oriented results
• Free tier: Up to 100 searches per day at no cost

Setup Steps

1. Enable YouTube Data API v3

   • Go to Google Cloud Console API Library
   • Click "Enable" (you may need to create a project first)

2. Create an API Key

   • Go to API Credentials
   • Click "Create Credentials" → "API key"
   • Copy the generated API key

3. Restrict the API Key (recommended for security)

   • Click on your new API key to edit it
   • Under "API restrictions", select "Restrict key"
   • Choose "YouTube Data API v3" from the list
   • Save

4. Set the environment variable

   export YOUTUBE_API_KEY="your-api-key-here"
   
   # Or add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
   echo 'export YOUTUBE_API_KEY="your-api-key-here"' >> ~/.bashrc
   

5. Run rytmuz - It will automatically use the API key if available

Usage

• Help: Press F1 or click the ? button to see all keyboard shortcuts and controls
• Search: Type in the search box and press Enter, or press Ctrl+S to focus search
• Play song: Click on a search result or press Enter when focused
• Recent songs: Click the ⏱ Recent button or press Ctrl+R
• Quit: Press Ctrl+C

Design Decisions

• No queueing: Immediate playback on selection (may add later)
• No auto-next: Stops after song ends (may add auto-advance at a later point)
• Minimal playback UI: No progress bar or timeline to keep focus on the music, not the interface
• Audio-only: No visualization to encourage listening and dancing vs screen time
• Fast replay: Cached URLs enable instant playback for favorite songs