yank-tui 0.1.0__tar.gz

yank_tui-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: yank-tui
+Version: 0.1.0
+Summary: A terminal UI wrapper for yt-dlp — paste URL, pick format, download
+Author: yank contributors
+License: MIT
+Project-URL: Homepage, https://github.com/wanazhar/yank
+Project-URL: Source, https://github.com/wanazhar/yank
+Project-URL: BugTracker, https://github.com/wanazhar/yank/issues
+Keywords: yt-dlp,tui,download,youtube,textual
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: textual>=0.80.0
+Requires-Dist: yt-dlp>=2024.1.0
+Requires-Dist: pyfiglet>=0.9
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+
+# yank ⬇️
+
+**A beautiful TUI wrapper for yt-dlp.** Paste a URL, pick a format, download. No flags to remember.
+
+```
+                      __
+   __  ______ _____  / /__
+  / / / / __ `/ __ \/ //_/
+ / /_/ / /_/ / / / / ,<
+ \__, /\__,_/_/ /_/_/|_|
+/____/
+
+         yt-dlp TUI wrapper
+
+    Paste a video URL · or multiple URLs (one per line) for batch
+
+  ┌────────────────────────────────────────────────────────────────┐
+  │ https://…                                                      │
+  └────────────────────────────────────────────────────────────────┘
+
+  ┌──────────────┐  ┌────────────────┐  ┌──────────────┐
+  │   Continue   │  │   Batch mode   │  │    Clear     │
+  └──────────────┘  └────────────────┘  └──────────────┘
+
+  Queue [F2]    History [F3]    Settings [F4]
+```
+
+## Features
+
+- **URL input** — paste one or multiple URLs, auto-detects platform (YouTube, TikTok, Twitter/X, Instagram, Vimeo, etc.)
+- **Format browser** — interactive table of available formats with resolution, codec, filesize
+- **Download manager** — real-time progress bars with speed, ETA, per-download controls
+- **Queue system** — batch multiple downloads, reorder, pause, cancel
+- **History** — every download logged with title, URL, format, and status
+- **Settings** — default download directory, format preferences, concurrent downloads, audio extraction
+- **yt-dlp management** — auto-installs and updates yt-dlp, no manual setup
+- **Beautiful dark theme** — purple/cyan accent palette with tasteful terminal styling
+- **Keyboard + mouse** — navigate with arrow keys or click
+
+## Installation
+
+### Quick install (recommended)
+
+```bash
+pipx install yank
+```
+
+### From source
+
+```bash
+git clone https://github.com/wanazhar/yank.git
+cd yank
+uv venv
+uv sync
+```
+
+## Usage
+
+```bash
+yank
+```
+
+Or from source:
+
+```bash
+cd yank && .venv/bin/python -m yank
+```
+
+### Workflow
+
+1. **Paste a URL** — the app opens to a clean input screen. Paste a video URL (YouTube, TikTok, etc.)
+2. **Choose format** — browse available formats in a sortable table. Best quality is pre-selected
+3. **Configure options** — set output directory, filename template, subtitles, thumbnail
+4. **Download** — watch real-time progress with speed and ETA
+5. **Done** — file saved, logged to history
+
+### Keyboard shortcuts
+
+| Key | Action |
+|-----|--------|
+| `Esc` | Back / Quit |
+| `F2` | Queue view |
+| `F3` | History |
+| `F4` | Settings |
+| `Ctrl+Q` | Quit |
+| `Ctrl+P` | Palette |
+| `↑↓` | Navigate |
+| `Space` | Select |
+| `Enter` | Confirm |
+
+## Configuration
+
+Config stored at `~/.config/yank/config.toml`:
+
+```toml
+download_dir = "/home/user/Downloads"
+format_preference = "best"
+max_concurrent = 2
+filename_template = "%(title)s.%(ext)s"
+subtitle_lang = "en"
+```
+
+## How it works
+
+yank wraps **yt-dlp** as a Python library (not subprocess). All format extraction, downloading, and metadata handling goes through `yt_dlp.YoutubeDL` with progress hooks. The TUI is built with **Textual** — a modern Python terminal UI framework.
+
+The app is fully local. No cloud, no accounts, no telemetry. Your downloads and history never leave your machine.
+
+## Requirements
+
+- Python 3.11+
+- A terminal that supports 24-bit color (most modern terminals do)
+- `ffmpeg` (optional — needed for some format merges and audio extraction)
+
+## License
+
+MIT

yank_tui-0.1.0/README.md

@@ -0,0 +1,117 @@
+# yank ⬇️
+
+**A beautiful TUI wrapper for yt-dlp.** Paste a URL, pick a format, download. No flags to remember.
+
+```
+                      __
+   __  ______ _____  / /__
+  / / / / __ `/ __ \/ //_/
+ / /_/ / /_/ / / / / ,<
+ \__, /\__,_/_/ /_/_/|_|
+/____/
+
+         yt-dlp TUI wrapper
+
+    Paste a video URL · or multiple URLs (one per line) for batch
+
+  ┌────────────────────────────────────────────────────────────────┐
+  │ https://…                                                      │
+  └────────────────────────────────────────────────────────────────┘
+
+  ┌──────────────┐  ┌────────────────┐  ┌──────────────┐
+  │   Continue   │  │   Batch mode   │  │    Clear     │
+  └──────────────┘  └────────────────┘  └──────────────┘
+
+  Queue [F2]    History [F3]    Settings [F4]
+```
+
+## Features
+
+- **URL input** — paste one or multiple URLs, auto-detects platform (YouTube, TikTok, Twitter/X, Instagram, Vimeo, etc.)
+- **Format browser** — interactive table of available formats with resolution, codec, filesize
+- **Download manager** — real-time progress bars with speed, ETA, per-download controls
+- **Queue system** — batch multiple downloads, reorder, pause, cancel
+- **History** — every download logged with title, URL, format, and status
+- **Settings** — default download directory, format preferences, concurrent downloads, audio extraction
+- **yt-dlp management** — auto-installs and updates yt-dlp, no manual setup
+- **Beautiful dark theme** — purple/cyan accent palette with tasteful terminal styling
+- **Keyboard + mouse** — navigate with arrow keys or click
+
+## Installation
+
+### Quick install (recommended)
+
+```bash
+pipx install yank
+```
+
+### From source
+
+```bash
+git clone https://github.com/wanazhar/yank.git
+cd yank
+uv venv
+uv sync
+```
+
+## Usage
+
+```bash
+yank
+```
+
+Or from source:
+
+```bash
+cd yank && .venv/bin/python -m yank
+```
+
+### Workflow
+
+1. **Paste a URL** — the app opens to a clean input screen. Paste a video URL (YouTube, TikTok, etc.)
+2. **Choose format** — browse available formats in a sortable table. Best quality is pre-selected
+3. **Configure options** — set output directory, filename template, subtitles, thumbnail
+4. **Download** — watch real-time progress with speed and ETA
+5. **Done** — file saved, logged to history
+
+### Keyboard shortcuts
+
+| Key | Action |
+|-----|--------|
+| `Esc` | Back / Quit |
+| `F2` | Queue view |
+| `F3` | History |
+| `F4` | Settings |
+| `Ctrl+Q` | Quit |
+| `Ctrl+P` | Palette |
+| `↑↓` | Navigate |
+| `Space` | Select |
+| `Enter` | Confirm |
+
+## Configuration
+
+Config stored at `~/.config/yank/config.toml`:
+
+```toml
+download_dir = "/home/user/Downloads"
+format_preference = "best"
+max_concurrent = 2
+filename_template = "%(title)s.%(ext)s"
+subtitle_lang = "en"
+```
+
+## How it works
+
+yank wraps **yt-dlp** as a Python library (not subprocess). All format extraction, downloading, and metadata handling goes through `yt_dlp.YoutubeDL` with progress hooks. The TUI is built with **Textual** — a modern Python terminal UI framework.
+
+The app is fully local. No cloud, no accounts, no telemetry. Your downloads and history never leave your machine.
+
+## Requirements
+
+- Python 3.11+
+- A terminal that supports 24-bit color (most modern terminals do)
+- `ffmpeg` (optional — needed for some format merges and audio extraction)
+
+## License
+
+MIT

yank_tui-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yank-tui"
+version = "0.1.0"
+description = "A terminal UI wrapper for yt-dlp — paste URL, pick format, download"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [{ name = "yank contributors" }]
+keywords = ["yt-dlp", "tui", "download", "youtube", "textual"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Video",
+]
+dependencies = [
+    "textual>=0.80.0",
+    "yt-dlp>=2024.1.0",
+    "pyfiglet>=0.9",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+]
+
+[project.scripts]
+yank = "yank.__main__:main"
+
+[project.urls]
+Homepage = "https://github.com/wanazhar/yank"
+Source = "https://github.com/wanazhar/yank"
+BugTracker = "https://github.com/wanazhar/yank/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

yank_tui-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yank_tui-0.1.0/src/yank/__init__.py

@@ -0,0 +1,3 @@
+"""yank — a TUI wrapper for yt-dlp."""
+
+__version__ = "0.1.0"

yank_tui-0.1.0/src/yank/__main__.py

@@ -0,0 +1,15 @@
+"""Entry point: ``python -m yank`` or ``yank`` CLI."""
+
+from __future__ import annotations
+
+
+def main() -> None:
+    """Launch the yank Textual application."""
+    from yank.app import YankApp
+
+    app = YankApp()
+    app.run()
+
+
+if __name__ == "__main__":
+    main()

yank_tui-0.1.0/src/yank/app.py

@@ -0,0 +1,301 @@
+"""Textual application class for yank."""
+
+from __future__ import annotations
+
+from textual import work
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.widgets import Footer, Header
+
+from yank.engine.downloader import DownloadItem, DownloadManager, DownloadStatus
+from yank.engine.queue import QueueEngine
+from yank.engine.updater import YtDlpManager
+from yank.models.config import AppConfig, load_config, save_config
+from yank.models.history import HistoryEntry, HistoryStore
+from yank.screens.url_input import URLInputScreen
+from yank.widgets.status_bar import StatusBar
+
+
+class YankApp(App):
+    """
+    yank — yt-dlp TUI wrapper.
+
+    Startup shows URL input immediately. Shared services (config, history,
+    download manager, queue, yt-dlp manager) live on the app instance.
+    """
+
+    TITLE = "yank"
+    SUB_TITLE = "yt-dlp TUI"
+    CSS = """
+    Screen {
+        background: #0a0a0f;
+        color: #e2e8f0;
+    }
+
+    /* Header styling */
+    Header {
+        dock: top;
+        background: #0a0a0f;
+        color: #a855f7;
+        text-style: bold;
+        padding: 0 1;
+        height: 1;
+    }
+
+    /* Footer styling */
+    Footer {
+        dock: bottom;
+        background: #0a0a0f;
+        color: #64748b;
+    }
+
+    /* Status bar styling */
+    StatusBar {
+        dock: bottom;
+        background: #0a0a0f;
+        color: #64748b;
+        border-top: solid #a855f7;
+        padding: 0 1;
+        height: 1;
+    }
+
+    /* Button styling */
+    Button {
+        background: #a855f7;
+        color: #e2e8f0;
+        padding: 0 2;
+        border: solid #a855f7;
+    }
+
+    Button:hover {
+        background: #9333ea;
+        border: solid #9333ea;
+    }
+
+    /* Content width constraints */
+    VerticalScroll, HorizontalScroll {
+        max-width: 120;
+    }
+
+    /* Section headers */
+    .section-header {
+        text-style: bold;
+        color: #7c3aed;
+        border-bottom: solid #06b6d4;
+        padding: 1 0;
+        margin: 1 0;
+    }
+
+    /* Input fields */
+    Input {
+        border: solid #06b6d4;
+        background: #0a0a0f;
+        color: #e2e8f0;
+        padding: 0 1;
+    }
+
+    Input:focus {
+        border: solid #06b6d4;
+        background: #0a0a0f;
+    }
+
+    /* Table styling */
+    DataTable {
+        background: #0a0a0f;
+    }
+
+    DataTable > .datatable--header {
+        background: #0a0a0f;
+        color: #06b6d4;
+        text-style: bold;
+    }
+
+    DataTable > .datatable--cursor {
+        background: #a855f7 40%;
+        border: solid #06b6d4;
+    }
+
+    /* Progress bar */
+    ProgressBar {
+        background: #1a1a2e;
+        color: #a855f7;
+    }
+
+    ProgressBar.complete {
+        color: #22c55e;
+    }
+    """
+
+    BINDINGS = [
+        Binding("ctrl+c", "quit", "Quit", show=False, priority=True),
+        Binding("ctrl+q", "quit", "Quit", show=True),
+    ]
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.config: AppConfig = load_config()
+        self.history = HistoryStore()
+        self.history.load()
+
+        self.manager = DownloadManager(
+            self.config,
+            on_progress=self._on_download_progress,
+            on_finished=self._on_download_finished,
+        )
+        self.queue = QueueEngine(
+            self.config,
+            self.manager,
+            on_change=self._on_queue_change,
+        )
+        self.ytdlp = YtDlpManager(self.config)
+        self._update_notice: str = ""
+
+    def compose(self) -> ComposeResult:
+        # Status bar is mounted on app level so it persists across screens.
+        # Screens have their own Header/Footer; we still dock StatusBar.
+        yield StatusBar(id="app-status")
+
+    def on_mount(self) -> None:
+        # Ensure yt-dlp present (async-ish via worker)
+        self._startup_ytdlp()
+        self.queue.load()
+        self.refresh_status_bar()
+        # Immediate URL input — no splash
+        self.push_screen(URLInputScreen())
+
+    def get_status_bar(self) -> StatusBar | None:
+        try:
+            return self.query_one("#app-status", StatusBar)
+        except Exception:
+            return None
+
+    def refresh_status_bar(self) -> None:
+        bar = self.get_status_bar()
+        if bar is None:
+            return
+        bar.set_status(
+            ytdlp_version=self.ytdlp.current_version(),
+            queue_size=self.queue.active_size(),
+            download_dir=self.config.download_dir,
+            notification=self._update_notice,
+        )
+
+    # ── Startup ─────────────────────────────────────────────────────────────
+
+    @work(thread=True)
+    def _startup_ytdlp(self) -> None:
+        """Install yt-dlp if missing; check for updates if due."""
+        if not self.ytdlp.is_installed():
+            self.call_from_thread(
+                self._set_notice, "Installing yt-dlp…"
+            )
+            ok = self.ytdlp.ensure_installed()
+            if ok:
+                self.call_from_thread(
+                    self._set_notice, f"yt-dlp {self.ytdlp.current_version()} installed."
+                )
+            else:
+                self.call_from_thread(
+                    self._set_notice, "yt-dlp missing — open Settings to install."
+                )
+            self.call_from_thread(self.refresh_status_bar)
+            return
+
+        if self.ytdlp.should_check_on_startup():
+            result = self.ytdlp.check_for_updates(force=True)
+            if result.update_available:
+                notice = f"Update available: yt-dlp {result.latest_version}"
+                self.call_from_thread(self._set_notice, notice)
+                self.call_from_thread(
+                    self.notify,
+                    f"yt-dlp update available: {result.current_version} → {result.latest_version}",
+                    severity="warning",
+                    timeout=8,
+                )
+            self.call_from_thread(self.refresh_status_bar)
+
+    def _set_notice(self, text: str) -> None:
+        self._update_notice = text
+        self.refresh_status_bar()
+        # Clear notice after a while via timer on main thread
+        self.set_timer(12.0, lambda: self._clear_notice_if(text))
+
+    def _clear_notice_if(self, text: str) -> None:
+        if self._update_notice == text:
+            self._update_notice = ""
+            self.refresh_status_bar()
+
+    # ── Download callbacks (may run on worker threads) ──────────────────────
+
+    def _on_download_progress(self, item: DownloadItem) -> None:
+        self.queue.sync_from_manager(item)
+        # UI widgets poll themselves; just refresh status occasionally
+        try:
+            self.call_from_thread(self.refresh_status_bar)
+        except Exception:
+            pass
+
+    def _on_download_finished(self, item: DownloadItem) -> None:
+        self.queue.sync_from_manager(item)
+
+        status_map = {
+            DownloadStatus.COMPLETED: "success",
+            DownloadStatus.ERROR: "error",
+            DownloadStatus.CANCELLED: "cancelled",
+        }
+        hist_status = status_map.get(item.status, "error")
+        if item.status in (
+            DownloadStatus.COMPLETED,
+            DownloadStatus.ERROR,
+            DownloadStatus.CANCELLED,
+        ):
+            # Calculate filesize if available
+            filesize = 0
+            if item.progress.total_bytes:
+                filesize = item.progress.total_bytes
+            elif item.progress.downloaded_bytes > 0:
+                filesize = item.progress.downloaded_bytes
+
+            entry = HistoryEntry.create(
+                title=item.title,
+                url=item.url,
+                format_id=item.format_id,
+                file_path=item.file_path,
+                status=hist_status,
+                error=item.error,
+                filesize=filesize,
+            )
+            try:
+                self.history.add(entry)
+            except Exception:
+                pass
+
+        def _notify() -> None:
+            self.refresh_status_bar()
+            if item.status == DownloadStatus.COMPLETED:
+                self.notify(f"Done: {item.title[:50]}", severity="information")
+            elif item.status == DownloadStatus.ERROR:
+                self.notify(
+                    f"Failed: {item.error or item.title[:40]}",
+                    severity="error",
+                    timeout=8,
+                )
+
+        try:
+            self.call_from_thread(_notify)
+        except Exception:
+            pass
+
+    def _on_queue_change(self) -> None:
+        try:
+            self.call_from_thread(self.refresh_status_bar)
+        except Exception:
+            pass
+
+    def action_quit(self) -> None:
+        try:
+            self.queue.save()
+            save_config(self.config)
+        except Exception:
+            pass
+        self.exit()

yank_tui-0.1.0/src/yank/engine/__init__.py

@@ -0,0 +1,26 @@
+"""Download engine: formats, downloader, queue, yt-dlp updater."""
+
+from yank.engine.downloader import DownloadItem, DownloadManager, DownloadProgress
+from yank.engine.formats import (
+    FormatInfo,
+    VideoMeta,
+    detect_platform,
+    extract_formats,
+    pick_best_format,
+)
+from yank.engine.queue import QueueEngine, QueueItem
+from yank.engine.updater import YtDlpManager
+
+__all__ = [
+    "DownloadItem",
+    "DownloadManager",
+    "DownloadProgress",
+    "FormatInfo",
+    "QueueEngine",
+    "QueueItem",
+    "VideoMeta",
+    "YtDlpManager",
+    "detect_platform",
+    "extract_formats",
+    "pick_best_format",
+]