opentune 0.2.1__py3-none-any.whl

opentune/__init__.py

@@ -0,0 +1,3 @@
+"""OpenTune terminal music player."""
+
+__version__ = "0.2.1"

opentune/__main__.py

@@ -0,0 +1,497 @@
+from __future__ import annotations
+
+import argparse
+import curses
+import json
+import os
+import shutil
+import socket
+import subprocess
+import sys
+import tempfile
+import threading
+import time
+import re
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+from urllib.parse import parse_qs, urlparse
+
+from . import __version__
+
+
+SEARCH_LIMIT = 12
+MIX_LIMIT = 10
+
+HELP_TEXT = """\
+OpenTune — stream YouTube music from your terminal
+
+Usage:
+  opentune [MUSIC ...]
+
+Examples:
+  opentune Daft Punk Get Lucky
+  opentune
+
+Options:
+  -h, --help     Show this help and exit.
+
+Player keys:
+  j / Down       Select next result or queue track
+  k / Up         Select previous result or queue track
+  Enter          Play the selected track
+  Space          Pause or resume
+  h / l          Previous / next track
+  H / L          Rewind / forward 10 seconds
+  Ctrl-l         Toggle looping for the current track
+  Tab            Switch between Results and Queue
+  /              Search YouTube from inside OpenTune
+  ?              Toggle this key reference in the TUI
+  q / Esc        Quit OpenTune
+
+OpenTune requires mpv and yt-dlp. It streams audio only and does not
+download tracks. Selecting a result creates a short related mix, shown
+in the Queue tab."""
+
+
+@dataclass(frozen=True)
+class Track:
+    title: str
+    url: str
+    duration: int = 0
+    uploader: str = ""
+
+    @property
+    def label(self) -> str:
+        return f"{self.title} — {self.uploader}" if self.uploader else self.title
+
+
+def format_time(seconds: float | int | None) -> str:
+    total = max(0, int(seconds or 0))
+    minutes, seconds = divmod(total, 60)
+    hours, minutes = divmod(minutes, 60)
+    return f"{hours}:{minutes:02d}:{seconds:02d}" if hours else f"{minutes}:{seconds:02d}"
+
+
+def require_tools() -> str | None:
+    absent = [name for name in ("mpv", "yt-dlp") if not shutil.which(name)]
+    return f"Missing required command(s): {', '.join(absent)}" if absent else None
+
+
+class YouTube:
+    """Small, deliberately dependency-free yt-dlp adapter."""
+
+    @staticmethod
+    def _fetch(target: str, label: str) -> list[Track]:
+        command = ["yt-dlp", "--flat-playlist", "--dump-single-json", target]
+        try:
+            completed = subprocess.run(command, capture_output=True, text=True, timeout=25, check=True)
+            payload = json.loads(completed.stdout)
+        except (subprocess.SubprocessError, json.JSONDecodeError) as error:
+            raise RuntimeError(f"{label} failed: {error}") from error
+        tracks: list[Track] = []
+        for entry in payload.get("entries") or []:
+            video_id = entry.get("id")
+            if not video_id:
+                continue
+            tracks.append(Track(
+                title=entry.get("title") or "Untitled",
+                url=entry.get("webpage_url") or f"https://www.youtube.com/watch?v={video_id}",
+                duration=int(entry.get("duration") or 0),
+                uploader=entry.get("uploader") or entry.get("channel") or "",
+            ))
+        return tracks
+
+    @classmethod
+    def search(cls, query: str, limit: int = SEARCH_LIMIT) -> list[Track]:
+        if not query.strip():
+            return []
+        return cls._fetch(f"ytsearch{limit}:{query}", "Search")
+
+    @staticmethod
+    def _video_id(url: str) -> str | None:
+        parsed = urlparse(url)
+        if parsed.netloc in {"youtu.be", "www.youtu.be"}:
+            return parsed.path.strip("/") or None
+        video_id = parse_qs(parsed.query).get("v", [None])[0]
+        return video_id
+
+    @staticmethod
+    def _track_key(track: Track) -> str:
+        """Create a loose song identity to exclude alternate uploads of a seed."""
+        title = track.title.lower()
+        if track.uploader:
+            title = title.replace(track.uploader.lower(), " ")
+        title = re.sub(r"\[[^]]*\]|\([^)]*\)", " ", title)
+        title = re.sub(
+            r"\b(official|audio|video|lyrics?|visuali[sz]er|music|hd|4k|remaster(?:ed)?)\b",
+            " ",
+            title,
+        )
+        return re.sub(r"\s+", " ", re.sub(r"[^a-z0-9]+", " ", title)).strip()
+
+    @classmethod
+    def _unique_mix(cls, seed: Track, candidates: list[Track]) -> list[Track]:
+        seed_key = cls._track_key(seed)
+        seen: set[str] = set()
+        mix: list[Track] = []
+        for candidate in candidates:
+            key = cls._track_key(candidate)
+            same_song = bool(seed_key and (key == seed_key or key.startswith(seed_key + " ") or seed_key.startswith(key + " ")))
+            if not key or candidate.url == seed.url or same_song or key in seen:
+                continue
+            seen.add(key)
+            mix.append(candidate)
+            if len(mix) == MIX_LIMIT:
+                break
+        return mix
+
+    @classmethod
+    def mix_for(cls, track: Track) -> list[Track]:
+        # YouTube's RD playlist is the same radio/mix mechanism exposed by its UI.
+        # It produces a varied sequence rather than search matches of the same video.
+        video_id = cls._video_id(track.url)
+        if video_id:
+            try:
+                radio = cls._fetch(
+                    f"https://www.youtube.com/watch?v={video_id}&list=RD{video_id}",
+                    "YouTube mix",
+                )
+                mix = cls._unique_mix(track, radio)
+                if mix:
+                    return mix
+            except RuntimeError:
+                pass
+
+        # Fallback when YouTube does not expose a radio playlist for a video.
+        artist = track.uploader or track.title
+        candidates = cls.search(f"{artist} songs", MIX_LIMIT * 3)
+        return cls._unique_mix(track, candidates)
+
+
+class MPV:
+    """Controls one headless mpv instance over its JSON IPC socket."""
+
+    def __init__(self, on_finished: callable) -> None:
+        self._on_finished = on_finished
+        self._directory = tempfile.TemporaryDirectory(prefix="opentune-")
+        self.socket_path = str(Path(self._directory.name) / "mpv.sock")
+        self.process: subprocess.Popen[str] | None = None
+        self._intentional_stop = False
+        self._lock = threading.Lock()
+
+    def play(self, track: Track, loop: bool = False) -> None:
+        self.stop()
+        self._intentional_stop = False
+        command = [
+            "mpv", "--no-video", "--force-window=no", "--really-quiet",
+            f"--input-ipc-server={self.socket_path}", "--ytdl-format=bestaudio/best", track.url,
+        ]
+        if loop:
+            command.insert(-1, "--loop-file=inf")
+        self.process = subprocess.Popen(command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, text=True)
+        threading.Thread(target=self._watch, args=(self.process,), daemon=True).start()
+
+    def _watch(self, process: subprocess.Popen[str]) -> None:
+        process.wait()
+        if not self._intentional_stop and process is self.process:
+            self._on_finished()
+
+    def command(self, command: list[Any]) -> Any | None:
+        if not self.process or self.process.poll() is not None:
+            return None
+        message = json.dumps({"command": command}) + "\n"
+        with self._lock:
+            try:
+                client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+                client.settimeout(0.25)
+                client.connect(self.socket_path)
+                client.sendall(message.encode())
+                response = client.recv(4096)
+                client.close()
+                return json.loads(response.decode().splitlines()[0]).get("data")
+            except (OSError, json.JSONDecodeError, IndexError):
+                return None
+
+    def toggle_pause(self) -> None:
+        self.command(["cycle", "pause"])
+
+    def seek(self, seconds: int) -> None:
+        self.command(["seek", seconds, "relative+exact"])
+
+    def set_loop(self, enabled: bool) -> None:
+        self.command(["set_property", "loop-file", "inf" if enabled else "no"])
+
+    def state(self) -> tuple[float, bool]:
+        position = self.command(["get_property", "playback-time"])
+        paused = self.command(["get_property", "pause"])
+        return float(position or 0), bool(paused)
+
+    def stop(self) -> None:
+        if self.process and self.process.poll() is None:
+            self._intentional_stop = True
+            self.command(["quit"])
+            try:
+                self.process.wait(timeout=1)
+            except subprocess.TimeoutExpired:
+                self.process.kill()
+        self.process = None
+
+    def close(self) -> None:
+        self.stop()
+        self._directory.cleanup()
+
+
+class Player:
+    def __init__(self) -> None:
+        self.current: Track | None = None
+        self.queue: list[Track] = []
+        self.history: list[Track] = []
+        self.loop = False
+        self.message = "Ready. Press / to search."
+        self._lock = threading.Lock()
+        self.mpv = MPV(self._finished)
+
+    def start(self, track: Track, *, build_mix: bool = True, remember_current: bool = True) -> None:
+        with self._lock:
+            if remember_current and self.current and self.current.url != track.url:
+                self.history.append(self.current)
+            self.current = track
+            self.mpv.play(track, self.loop)
+            self.message = f"Playing: {track.title}"
+        if build_mix:
+            threading.Thread(target=self._build_mix, args=(track,), daemon=True).start()
+
+    def _build_mix(self, track: Track) -> None:
+        try:
+            mix = YouTube.mix_for(track)
+            with self._lock:
+                if self.current == track:
+                    existing = {item.url for item in self.queue}
+                    self.queue.extend(item for item in mix if item.url not in existing)
+                    self.message = f"Mix ready: {len(self.queue)} tracks queued"
+        except RuntimeError:
+            pass
+
+    def next(self) -> None:
+        with self._lock:
+            if not self.queue:
+                self.message = "Queue is empty"
+                return
+            next_track = self.queue.pop(0)
+        self.start(next_track, build_mix=False)
+
+    def previous(self) -> None:
+        with self._lock:
+            if not self.history:
+                self.message = "No previous track"
+                return
+            previous_track = self.history.pop()
+            if self.current:
+                self.queue.insert(0, self.current)
+        self.start(previous_track, build_mix=False, remember_current=False)
+
+    def _finished(self) -> None:
+        if not self.loop:
+            self.next()
+
+    def toggle_loop(self) -> None:
+        self.loop = not self.loop
+        self.mpv.set_loop(self.loop)
+        self.message = f"Loop {'on' if self.loop else 'off'}"
+
+    def close(self) -> None:
+        self.mpv.close()
+
+
+class TUI:
+    def __init__(self, screen: curses.window, player: Player, initial_query: str = "") -> None:
+        self.screen, self.player = screen, player
+        self.results: list[Track] = []
+        self.result_index = 0
+        self.queue_index = 0
+        self.tab = 0  # 0 results, 1 queue
+        self.running = True
+        self.showing_help = False
+        curses.curs_set(0)
+        screen.nodelay(True)
+        screen.keypad(True)
+        if initial_query:
+            self.search(initial_query)
+
+    def search(self, query: str) -> None:
+        self.player.message = f"Searching YouTube for: {query}"
+        self.draw()
+        try:
+            self.results = YouTube.search(query)
+            self.result_index = 0
+            self.tab = 0
+            self.player.message = f"{len(self.results)} results for “{query}”"
+        except RuntimeError as error:
+            self.player.message = str(error)
+
+    def prompt_search(self) -> None:
+        height, _ = self.screen.getmaxyx()
+        self.screen.nodelay(False)
+        curses.curs_set(1)
+        # curses.wrapper() enables noecho for the TUI. Turn echo on only for this
+        # text field so a query is visible as the user types it.
+        curses.echo()
+        self.screen.move(height - 1, 0)
+        self.screen.clrtoeol()
+        self.screen.addstr(height - 1, 0, "Search: ")
+        try:
+            query = self.screen.getstr(height - 1, 8).decode().strip()
+        except KeyboardInterrupt:
+            query = ""
+        finally:
+            curses.noecho()
+        curses.curs_set(0)
+        self.screen.nodelay(True)
+        if query:
+            self.search(query)
+
+    @staticmethod
+    def clipped(value: str, width: int) -> str:
+        return value if len(value) <= width else value[: max(0, width - 1)] + "…"
+
+    def draw_track_list(self, items: list[Track], selected: int, top: int, height: int, width: int) -> None:
+        if not items:
+            self.screen.addstr(top, 2, "Nothing here yet.", curses.A_DIM)
+            return
+        start = max(0, min(selected - height + 1, len(items) - height))
+        for line, index in enumerate(range(start, min(len(items), start + height))):
+            item = items[index]
+            marker = "›" if index == selected else " "
+            duration = format_time(item.duration)
+            text = f"{marker} {index + 1:2}. {item.label}  [{duration}]"
+            attr = curses.A_REVERSE if index == selected else curses.A_NORMAL
+            self.screen.addnstr(top + line, 1, self.clipped(text, width - 2), width - 2, attr)
+
+    def draw(self) -> None:
+        self.screen.erase()
+        height, width = self.screen.getmaxyx()
+        current = self.player.current
+        position, paused = self.player.mpv.state() if current else (0, False)
+        title = current.title if current else "Nothing playing"
+        duration = current.duration if current else 0
+        mode = "PAUSED" if paused else "PLAYING" if current else "IDLE"
+        loop = " LOOP" if self.player.loop else ""
+        self.screen.addnstr(0, 1, f" OPENTUNE  ·  {mode}{loop}", width - 2, curses.A_BOLD)
+        self.screen.hline(1, 0, curses.ACS_HLINE, width)
+        self.screen.addnstr(2, 2, self.clipped(title, width - 4), width - 4, curses.A_BOLD)
+        self.screen.addnstr(3, 2, f"{format_time(position)} / {format_time(duration)}", width - 4, curses.A_DIM)
+        self.screen.hline(5, 0, curses.ACS_HLINE, width)
+        tabs = "[ Results ]" if self.tab == 0 else "  Results  "
+        tabs += "     " + ("[ Queue ]" if self.tab == 1 else "  Queue  ")
+        self.screen.addnstr(6, 2, tabs, width - 4, curses.A_BOLD)
+        list_height = max(1, height - 10)
+        if self.showing_help:
+            self.draw_help(8, width, list_height)
+        elif self.tab == 0:
+            self.draw_track_list(self.results, self.result_index, 8, list_height, width)
+        else:
+            self.draw_track_list(self.player.queue, self.queue_index, 8, list_height, width)
+        self.screen.hline(height - 2, 0, curses.ACS_HLINE, width)
+        status = self.clipped(self.player.message, width - 4)
+        self.screen.addnstr(height - 1, 2, status, width - 4, curses.A_DIM)
+        self.screen.refresh()
+
+    def draw_help(self, top: int, width: int, height: int) -> None:
+        lines = [
+            "KEY REFERENCE  (press ? or Esc to return)",
+            "",
+            "j / ↓    down       k / ↑    up        Enter    play selection",
+            "Space    pause/play h        previous  l        next",
+            "H        rewind 10s L        forward 10s Ctrl-l   toggle loop",
+            "Tab      Results/Queue       /        search     q        quit",
+            "",
+            "Selecting a result starts playback and prepares a related mix in Queue.",
+        ]
+        for index, line in enumerate(lines[:height]):
+            attr = curses.A_BOLD if index == 0 else curses.A_NORMAL
+            self.screen.addnstr(top + index, 2, self.clipped(line, width - 4), width - 4, attr)
+
+    def move(self, delta: int) -> None:
+        if self.tab == 0:
+            self.result_index = max(0, min(len(self.results) - 1, self.result_index + delta))
+        else:
+            self.queue_index = max(0, min(len(self.player.queue) - 1, self.queue_index + delta))
+
+    def select(self) -> None:
+        if self.tab == 0 and self.results:
+            self.player.start(self.results[self.result_index])
+        elif self.tab == 1 and self.player.queue:
+            with self.player._lock:
+                track = self.player.queue.pop(self.queue_index)
+            self.queue_index = max(0, min(self.queue_index, len(self.player.queue) - 1))
+            self.player.start(track, build_mix=False)
+
+    def handle(self, key: int) -> None:
+        if self.showing_help:
+            if key in (ord("?"), 27, ord("q")):
+                self.showing_help = False
+            return
+        if key in (ord("q"), 27):
+            self.running = False
+        elif key in (ord("j"), curses.KEY_DOWN):
+            self.move(1)
+        elif key in (ord("k"), curses.KEY_UP):
+            self.move(-1)
+        elif key in (9,):
+            self.tab = 1 - self.tab
+        elif key in (10, 13, curses.KEY_ENTER):
+            self.select()
+        elif key == ord(" "):
+            self.player.mpv.toggle_pause()
+        elif key == ord("h"):
+            self.player.previous()
+        elif key == ord("l"):
+            self.player.next()
+        elif key == ord("H"):
+            self.player.mpv.seek(-10)
+        elif key == ord("L"):
+            self.player.mpv.seek(10)
+        elif key == 12:  # Ctrl-l
+            self.player.toggle_loop()
+        elif key == ord("/"):
+            self.prompt_search()
+        elif key == ord("?"):
+            self.showing_help = True
+
+    def run(self) -> None:
+        while self.running:
+            self.draw()
+            key = self.screen.getch()
+            if key != -1:
+                self.handle(key)
+            time.sleep(0.08)
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(
+        prog="opentune",
+        description="A Vim-keyed terminal music player for YouTube audio streams.",
+        epilog=HELP_TEXT,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+    parser.add_argument("query", nargs="*", help="Search query to open on launch")
+    args = parser.parse_args()
+    missing = require_tools()
+    if missing:
+        print(f"opentune: {missing}", file=sys.stderr)
+        return 1
+    player = Player()
+    try:
+        curses.wrapper(lambda screen: TUI(screen, player, " ".join(args.query)).run())
+    except curses.error as error:
+        print(f"opentune: terminal UI error: {error}", file=sys.stderr)
+        return 1
+    finally:
+        player.close()
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

opentune-0.2.1.dist-info/METADATA

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: opentune
+Version: 0.2.1
+Summary: A Vim-keyed terminal music player for YouTube audio streams
+License-Expression: Apache-2.0
+Keywords: music,youtube,terminal,tui,mpv,yt-dlp
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: Players
+Classifier: Topic :: Terminals
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# OpenTune
+
+OpenTune is a terminal music player for Linux/Unix systems. Search YouTube for a song, choose a result using Vim-style keys, and listen without leaving the terminal.
+
+It is deliberately small: OpenTune streams audio; it does not download songs, require a browser, require a YouTube account, or maintain a media library. Playback happens in a full-screen terminal UI (TUI).
+
+## What it can do
+
+- Search YouTube from the command line: `opentune <music name>`
+- Show several matching tracks with artist/channel and duration
+- Play, pause, go to the next/previous track, seek, and loop a track
+- Use Vim-like navigation (`h`, `j`, `k`, `l`) as well as arrow keys
+- Create a short related mix after you choose a song
+- Show the upcoming mix in a Queue tab
+- Display the playing title, elapsed time, total duration, and playback state
+
+## How it works
+
+OpenTune coordinates two established command-line programs:
+
+1. `yt-dlp` searches YouTube and returns video title, channel, duration, and URL.
+2. OpenTune shows those results in its terminal UI.
+3. When a track is selected, `mpv` opens the YouTube URL and streams the best available audio format.
+4. OpenTune controls `mpv` through a private local socket, so pause, seek, loop, and progress updates work while the TUI remains open.
+5. In the background, OpenTune asks YouTube for its radio/mix playlist seeded by the selected video, then filters alternate uploads of the same song before filling the queue. If YouTube does not expose a radio playlist, OpenTune falls back to other songs from the selected artist.
+
+Nothing is downloaded or uploaded by OpenTune. Search, stream playback, and mix generation need an active internet connection.
+
+## Requirements
+
+Install these before installing OpenTune:
+
+- Python 3.10 or newer
+- [`mpv`](https://mpv.io/) — audio playback and YouTube streaming
+- [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) — YouTube search metadata
+
+Examples for common Linux distributions:
+
+```sh
+# Arch Linux
+sudo pacman -S python mpv yt-dlp
+
+# Debian / Ubuntu
+sudo apt install python3 python3-pip mpv yt-dlp
+
+# Fedora
+sudo dnf install python3 python3-pip mpv yt-dlp
+```
+
+If YouTube changes its site, updating `yt-dlp` is usually the first thing to try when search or playback stops working.
+
+## Installation
+
+On current Arch Linux, do **not** use `pip install --user` for this project. Arch marks its system Python as externally managed (PEP 668), so `pip` correctly refuses to modify it. Choose one of the following isolated installation methods.
+
+### Recommended: install the CLI with pipx
+
+`pipx` installs Python applications into their own virtual environments while exposing their commands on your `PATH`. This is the best option when you want to run `opentune` from any directory.
+
+```sh
+# Install pipx once on Arch Linux
+sudo pacman -S python-pipx
+pipx ensurepath
+
+# Open a new terminal, then install this checkout
+cd /path/to/opentune
+pipx install .
+```
+
+Afterward, use it like any other command:
+
+```sh
+opentune "Daft Punk Get Lucky"
+opentune --help
+```
+
+If `opentune` is not found immediately after `pipx ensurepath`, restart the shell. `pipx` normally adds `~/.local/bin` to your `PATH`.
+
+### Updating an installation from this checkout
+
+`pipx upgrade opentune` checks the package's published source (usually PyPI). It cannot detect edits made only in this local Git checkout, even if the local version number changes. To install the current checkout after pulling or editing code, run this from the project directory:
+
+```sh
+pipx install --force .
+```
+
+Or use the included shortcut:
+
+```sh
+make upgrade
+```
+
+Confirm the installed release with:
+
+```sh
+opentune --version
+```
+
+OpenTune follows semantic versioning: patch releases (for example `0.2.0` → `0.2.1`) contain fixes, while minor releases add backwards-compatible features.
+
+### Alternative: project virtual environment
+
+Use this when developing OpenTune or when you only need the command from this checkout:
+
+```sh
+cd /path/to/opentune
+python3 -m venv .venv
+source .venv/bin/activate
+python -m pip install .
+opentune "Daft Punk Get Lucky"
+```
+
+Important: omit `--user` inside a virtual environment. The virtual environment already isolates the installation, and Python intentionally hides user site-packages from it.
+
+While the environment is active, `opentune` works normally. After `deactivate`, either activate it again or run the executable explicitly:
+
+```sh
+.venv/bin/opentune "Daft Punk Get Lucky"
+```
+
+Do not use `--break-system-packages`; it bypasses Arch's protection for the system Python and is unnecessary for OpenTune.
+
+### Install from PyPI
+
+After OpenTune's first PyPI release, installation and future upgrades will work from any directory:
+
+```sh
+pipx install opentune
+pipx upgrade opentune
+```
+
+Maintainers can follow [the PyPI release guide](docs/PYPI_RELEASE.md) to configure Trusted Publishing and publish releases.
+
+### Run without installing
+
+For development or a one-off run from this checkout:
+
+```sh
+./bin/opentune "Daft Punk Get Lucky"
+```
+
+## Usage
+
+Start OpenTune and search immediately:
+
+```sh
+opentune "Daft Punk Get Lucky"
+```
+
+Words after `opentune` form the search query, so quotes are optional unless your shell needs them:
+
+```sh
+opentune Kendrick Lamar
+```
+
+Start with an empty player and search from inside the TUI instead:
+
+```sh
+opentune
+```
+
+Use the standard command help at any time:
+
+```sh
+opentune --help
+```
+
+## First run
+
+1. Run `opentune <song or artist>`.
+2. A list of YouTube matches appears in the **Results** tab.
+3. Move with `j`/`k` or `↓`/`↑`.
+4. Press `Enter` to start the highlighted result.
+5. The title and time appear at the top of the screen.
+6. OpenTune prepares related tracks in the background. Press `Tab` to view them in the **Queue** tab.
+7. Press `q` or `Esc` to quit.
+
+## Keybinds
+
+| Key | Action |
+| --- | --- |
+| `j` or `↓` | Move selection down in Results or Queue |
+| `k` or `↑` | Move selection up in Results or Queue |
+| `Enter` | Play the selected result or queue item |
+| `Space` | Pause or resume playback |
+| `h` | Play the previous track, if there is one |
+| `l` | Play the next queued track |
+| `H` (`Shift+h`) | Rewind 10 seconds |
+| `L` (`Shift+l`) | Forward 10 seconds |
+| `Ctrl+l` | Toggle looping of the current track |
+| `Tab` | Switch between **Results** and **Queue** |
+| `/` | Open a search prompt |
+| `?` | Open/close the in-player key reference |
+| `q` or `Esc` | Quit OpenTune (or close the `?` help overlay) |
+
+## Results, playback, and the queue
+
+### Results tab
+
+The Results tab contains the latest YouTube search. Each row shows its title, channel/uploader when available, and duration. Press `Enter` to play a result. Choosing a new search result replaces the current track and adds the former track to playback history, allowing `h` to go back.
+
+### Queue tab
+
+Selecting a search result starts a short YouTube radio-style mix. OpenTune filters duplicate uploads and alternate versions of the selected song, so the queue should contain different songs rather than the same title from several channels. The Queue tab shows the tracks waiting to play. You can:
+
+- Press `l` to start the next queued track.
+- Highlight a queued track and press `Enter` to jump directly to it.
+- Use `Tab` to return to Results.
+
+The queue is kept in memory for the current session only. It is cleared when OpenTune exits.
+
+### Looping
+
+`Ctrl+l` loops the currently playing track. The screen header displays `LOOP` while it is enabled. Turn it off with `Ctrl+l` again; then, when a track ends, OpenTune advances to the next item in the queue.
+
+## Troubleshooting
+
+### `opentune: command not found`
+
+The user-level bin directory is likely not on `PATH`. Run:
+
+```sh
+export PATH="$HOME/.local/bin:$PATH"
+```
+
+Then add it to `~/.zshrc` or your shell's startup file as described above.
+
+### Missing `mpv` or `yt-dlp`
+
+OpenTune checks for both commands at startup. Install the missing package with your distribution's package manager, then run OpenTune again.
+
+### Search or playback fails
+
+- Confirm that the internet connection and YouTube are reachable.
+- Update `yt-dlp`; YouTube changes can require a newer version.
+- Try the URL in `mpv` directly to distinguish an OpenTune issue from a `mpv`/`yt-dlp` issue:
+
+  ```sh
+  mpv --no-video "https://www.youtube.com/watch?v=VIDEO_ID"
+  ```
+
+### The terminal UI looks broken
+
+OpenTune needs an interactive terminal with enough space for the player. Enlarge the terminal window and avoid running it through a non-interactive shell or redirected output.
+
+## Project layout
+
+```text
+opentune/
+├── bin/opentune          # launcher for running from this checkout
+├── opentune/__main__.py  # CLI, terminal UI, search, queue, and mpv control
+├── tests/                # small automated checks
+├── Makefile               # install, local pipx upgrade, and test shortcuts
+└── pyproject.toml        # package metadata and installed `opentune` command
+```
+
+## Current scope and limitations
+
+OpenTune v1 is a streaming player. It does not yet provide persistent playlists, saved favorites, downloads, lyrics, volume controls, or system media-key integration. These are good candidates for later releases, but the current goal is fast terminal search and playback with a lightweight mix queue.
+
+## License
+
+Copyright 2026 Rudraksh.
+
+OpenTune is licensed under the [Apache License 2.0](LICENSE). It includes an explicit patent grant; see [NOTICE](NOTICE) for the project attribution notice.

opentune-0.2.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+opentune/__init__.py,sha256=I2yhmHsPpw_O5xGvZQgnwU8rWYEhjh1xCdA-HYhNN-I,61
+opentune/__main__.py,sha256=kGa0M9RN-H3-rKogG0EZQVBw0Qe7CzraiXxniRbQgiI,18696
+opentune-0.2.1.dist-info/licenses/LICENSE,sha256=UpiDt2c2SRYNOl_hfkRYfSScU9wrJ5-Zu-yq4tuxFM4,11338
+opentune-0.2.1.dist-info/METADATA,sha256=dA0P7CMNHQ0WTaGXZPobcYbNvM06Bb10Fmy_2FSTY2s,10370
+opentune-0.2.1.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+opentune-0.2.1.dist-info/entry_points.txt,sha256=78e_ShJiGx-LXv5cWDGPV5mRiK0gPiu8vW8vkYfv_T0,52
+opentune-0.2.1.dist-info/top_level.txt,sha256=fO5xHwCf9HjxPAHLoufKolZR5q0VerD8KIfJ2-09jsE,9
+opentune-0.2.1.dist-info/RECORD,,

opentune-0.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

opentune-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+opentune = opentune.__main__:main

opentune-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Rudraksh
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

opentune-0.2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+opentune