rift-tui 1.0.1__tar.gz

rift_tui-1.0.1/.gitignore

@@ -0,0 +1,31 @@
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+accounts.json
+app_settings.json
+
+venv/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+
+# env files (can opt-in for committing if needed)
+.env*
+
+

rift_tui-1.0.1/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: rift-tui
+Version: 1.0.1
+Summary: A terminal-based League of Legends stats tracker built with Textual
+Project-URL: Homepage, https://github.com/rileriaaa/rift-tui
+Project-URL: Repository, https://github.com/rileriaaa/rift-tui
+Project-URL: Issues, https://github.com/rileriaaa/rift-tui/issues
+Author: rileria
+License: MIT
+Keywords: league-of-legends,riot-api,terminal,textual,tui
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Terminals
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: pyperclip>=1.8.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: textual>=0.50.0
+Description-Content-Type: text/markdown
+
+# rift-tui
+
+A terminal-based League of Legends stats tracker built with Python and [Textual](https://github.com/Textualize/textual). Three-panel dashboard — rank, recent form, champion mastery, match history, top champions, and full per-match breakdowns (runes, spells, items, objectives, gold/XP diff over time) — all live from Riot's API.
+
+## Features
+
+- **Live profile tracking** — rank, LP, recent-form sparkline, champion mastery, last 10 matches, top champions
+- **Match detail** — full scoreboard both teams, bans, objectives, runes, summoner spells, multikill badges, kill participation / damage-per-minute, item builds, and a gold/XP/damage timeline chart per match
+- **Search any player** — region-aware, arrow-key platform picker (no need to know Riot's routing codes)
+- **Bookmarks** — save favorite Riot IDs, jump to them with one keypress
+- **Multi-account** — track a main + smurfs, switch between them
+- **Compare mode** — side-by-side stat comparison against a searched player
+- **Queue filter** — Solo / Flex / ARAM
+- **Champion filter** — filter your match list down to one champion
+- **In-app settings** — manage tracked accounts, bookmarks, refresh interval, and your Riot API key, all without touching a config file
+- **Copy Riot ID to clipboard** — one key, no manual selecting
+- **Scrollable, resizable panels** — Tab to focus a panel, arrow keys or mouse wheel to scroll
+- **Built-in help overlay** — full keybind reference, one key away
+
+## Requirements
+
+- Python 3.10+
+- A free Riot Developer API key ([get one here](https://developer.riotgames.com/)) — personal dev keys expire every 24h, this is normal Riot behavior, not a bug
+- A terminal that properly supports ANSI/VT input. **On Windows, use [Windows Terminal](https://apps.microsoft.com/detail/9n0dx20hk701)** — legacy `cmd.exe` and the old PowerShell console host don't handle keyboard input correctly for full-screen terminal apps like this one. If you're on Windows 10 LTSC (no Microsoft Store), grab the portable build from [Terminal's GitHub releases](https://github.com/microsoft/terminal/releases), or use [WezTerm](https://wezfurlong.org/wezterm/) / [Alacritty](https://alacritty.org/) instead.
+
+## Installation
+
+```bash
+pipx install rift-tui
+rift-tui
+```
+[pipx](https://pipx.pypa.io/) installs it in its own isolated environment and puts the `rift-tui` command on your PATH. If you don't have pipx yet:
+```bash
+python -m pip install --user pipx
+pipx ensurepath
+```
+(restart your terminal after that last command)
+
+**From source (for development):**
+```bash
+git clone https://github.com/rileriaaa/rift-tui.git
+cd rift-tui
+pip install -e .
+```
+
+## First run
+
+On first launch, rift-tui walks you through setup — no config files to hand-edit:
+
+1. **Paste your Riot API key** when prompted (or press `Esc` to skip and add it later with `K`)
+2. **Enter your Riot ID** (e.g. `YourName#TAG`) and pick your region with `←`/`→` (or skip and add it later with `A`)
+
+That's it — your account and key are saved locally and reused on every future launch.
+
+## Keybinds
+
+| Key | Action |
+|---|---|
+| `/` | Search for a player |
+| `1`–`9`, `0` | Open match 1–10 detail |
+| `Esc` | Back / close whatever's open |
+| `Tab` | Switch panel focus |
+| `↑` `↓` | Scroll the focused panel (or browse recent searches / recent bookmarks while typing) |
+| `←` `→` | Change region while searching or adding a player |
+| `R` | Refresh now |
+| `I` | Cycle auto-refresh interval |
+| `T` | Cycle queue type (Solo / Flex / ARAM) |
+| `F` | Filter match list by champion |
+| `A` | Manage tracked accounts (add/remove) |
+| `N` | Switch to next tracked account |
+| `B` | Bookmarks — open list / add current or new player |
+| `C` | Toggle compare mode (while viewing a searched player) |
+| `Y` | Copy the currently viewed Riot ID to clipboard |
+| `K` | Add or update your Riot API key — no `.env` editing needed |
+| `?` | Show the help overlay |
+| `Q` | Quit |
+
+## Where your data lives
+
+Nothing is stored next to the installed package. rift-tui uses your OS's proper per-user data folder (via `platformdirs`) — e.g. `%LOCALAPPDATA%\rift-tui` on Windows, `~/.local/share/rift-tui` on Linux:
+
+- `accounts.json` — your tracked accounts
+- `bookmarks.json` — saved players
+- `app_settings.json` — refresh interval and your API key
+
+## Troubleshooting
+
+- **"Rate limited by Riot API (429)"** — personal dev keys are capped at 20 requests/second and 100 requests/2 minutes. Wait a moment and retry.
+- **"Invalid or expired Riot API key"** — dev keys expire every 24 hours. Press `K` in-app to paste a fresh one, no restart needed.
+- **"Player not found"** — double check the exact Riot ID (`name#tag`), and try a different region with `←`/`→` — Riot IDs are region-locked to wherever the account actually plays.
+- **Keys not responding on Windows** — see the terminal note under Requirements above.
+- **Screen looks broken on a small window** — `Tab` to focus a panel, then scroll it with arrow keys or your mouse wheel.
+
+## A note on API keys
+
+This project uses a **bring-your-own-key** model: each user gets their own free personal Riot API key rather than the app shipping with one baked in. This isn't a limitation — Riot's developer terms explicitly prohibit embedding any API key (personal or production) in software you distribute to others, and personal keys are specifically meant for exactly this kind of individual-use tool.
+
+## License
+
+MIT

rift_tui-1.0.1/README.md

@@ -0,0 +1,100 @@
+# rift-tui
+
+A terminal-based League of Legends stats tracker built with Python and [Textual](https://github.com/Textualize/textual). Three-panel dashboard — rank, recent form, champion mastery, match history, top champions, and full per-match breakdowns (runes, spells, items, objectives, gold/XP diff over time) — all live from Riot's API.
+
+## Features
+
+- **Live profile tracking** — rank, LP, recent-form sparkline, champion mastery, last 10 matches, top champions
+- **Match detail** — full scoreboard both teams, bans, objectives, runes, summoner spells, multikill badges, kill participation / damage-per-minute, item builds, and a gold/XP/damage timeline chart per match
+- **Search any player** — region-aware, arrow-key platform picker (no need to know Riot's routing codes)
+- **Bookmarks** — save favorite Riot IDs, jump to them with one keypress
+- **Multi-account** — track a main + smurfs, switch between them
+- **Compare mode** — side-by-side stat comparison against a searched player
+- **Queue filter** — Solo / Flex / ARAM
+- **Champion filter** — filter your match list down to one champion
+- **In-app settings** — manage tracked accounts, bookmarks, refresh interval, and your Riot API key, all without touching a config file
+- **Copy Riot ID to clipboard** — one key, no manual selecting
+- **Scrollable, resizable panels** — Tab to focus a panel, arrow keys or mouse wheel to scroll
+- **Built-in help overlay** — full keybind reference, one key away
+
+## Requirements
+
+- Python 3.10+
+- A free Riot Developer API key ([get one here](https://developer.riotgames.com/)) — personal dev keys expire every 24h, this is normal Riot behavior, not a bug
+- A terminal that properly supports ANSI/VT input. **On Windows, use [Windows Terminal](https://apps.microsoft.com/detail/9n0dx20hk701)** — legacy `cmd.exe` and the old PowerShell console host don't handle keyboard input correctly for full-screen terminal apps like this one. If you're on Windows 10 LTSC (no Microsoft Store), grab the portable build from [Terminal's GitHub releases](https://github.com/microsoft/terminal/releases), or use [WezTerm](https://wezfurlong.org/wezterm/) / [Alacritty](https://alacritty.org/) instead.
+
+## Installation
+
+```bash
+pipx install rift-tui
+rift-tui
+```
+[pipx](https://pipx.pypa.io/) installs it in its own isolated environment and puts the `rift-tui` command on your PATH. If you don't have pipx yet:
+```bash
+python -m pip install --user pipx
+pipx ensurepath
+```
+(restart your terminal after that last command)
+
+**From source (for development):**
+```bash
+git clone https://github.com/rileriaaa/rift-tui.git
+cd rift-tui
+pip install -e .
+```
+
+## First run
+
+On first launch, rift-tui walks you through setup — no config files to hand-edit:
+
+1. **Paste your Riot API key** when prompted (or press `Esc` to skip and add it later with `K`)
+2. **Enter your Riot ID** (e.g. `YourName#TAG`) and pick your region with `←`/`→` (or skip and add it later with `A`)
+
+That's it — your account and key are saved locally and reused on every future launch.
+
+## Keybinds
+
+| Key | Action |
+|---|---|
+| `/` | Search for a player |
+| `1`–`9`, `0` | Open match 1–10 detail |
+| `Esc` | Back / close whatever's open |
+| `Tab` | Switch panel focus |
+| `↑` `↓` | Scroll the focused panel (or browse recent searches / recent bookmarks while typing) |
+| `←` `→` | Change region while searching or adding a player |
+| `R` | Refresh now |
+| `I` | Cycle auto-refresh interval |
+| `T` | Cycle queue type (Solo / Flex / ARAM) |
+| `F` | Filter match list by champion |
+| `A` | Manage tracked accounts (add/remove) |
+| `N` | Switch to next tracked account |
+| `B` | Bookmarks — open list / add current or new player |
+| `C` | Toggle compare mode (while viewing a searched player) |
+| `Y` | Copy the currently viewed Riot ID to clipboard |
+| `K` | Add or update your Riot API key — no `.env` editing needed |
+| `?` | Show the help overlay |
+| `Q` | Quit |
+
+## Where your data lives
+
+Nothing is stored next to the installed package. rift-tui uses your OS's proper per-user data folder (via `platformdirs`) — e.g. `%LOCALAPPDATA%\rift-tui` on Windows, `~/.local/share/rift-tui` on Linux:
+
+- `accounts.json` — your tracked accounts
+- `bookmarks.json` — saved players
+- `app_settings.json` — refresh interval and your API key
+
+## Troubleshooting
+
+- **"Rate limited by Riot API (429)"** — personal dev keys are capped at 20 requests/second and 100 requests/2 minutes. Wait a moment and retry.
+- **"Invalid or expired Riot API key"** — dev keys expire every 24 hours. Press `K` in-app to paste a fresh one, no restart needed.
+- **"Player not found"** — double check the exact Riot ID (`name#tag`), and try a different region with `←`/`→` — Riot IDs are region-locked to wherever the account actually plays.
+- **Keys not responding on Windows** — see the terminal note under Requirements above.
+- **Screen looks broken on a small window** — `Tab` to focus a panel, then scroll it with arrow keys or your mouse wheel.
+
+## A note on API keys
+
+This project uses a **bring-your-own-key** model: each user gets their own free personal Riot API key rather than the app shipping with one baked in. This isn't a limitation — Riot's developer terms explicitly prohibit embedding any API key (personal or production) in software you distribute to others, and personal keys are specifically meant for exactly this kind of individual-use tool.
+
+## License
+
+MIT

rift_tui-1.0.1/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rift-tui"
+version = "1.0.1"
+description = "A terminal-based League of Legends stats tracker built with Textual"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [
+    { name = "rileria" },
+]
+keywords = ["league-of-legends", "riot-api", "tui", "textual", "terminal"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Topic :: Games/Entertainment",
+    "Topic :: Terminals",
+]
+dependencies = [
+    "textual>=0.50.0",
+    "httpx>=0.27.0",
+    "python-dotenv>=1.0.0",
+    "platformdirs>=4.0.0",
+    "pyperclip>=1.8.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/rileriaaa/rift-tui"
+Repository = "https://github.com/rileriaaa/rift-tui"
+Issues = "https://github.com/rileriaaa/rift-tui/issues"
+
+[project.scripts]
+rift-tui = "rift_tui.__main__:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rift_tui"]

rift_tui-1.0.1/src/rift_tui/__init__.py

@@ -0,0 +1,7 @@
+"""rift_tui — a terminal-based League of Legends stats tracker."""
+
+__version__ = "1.0.1"
+
+from rift_tui.main import run
+
+__all__ = ["run"]

rift_tui-1.0.1/src/rift_tui/__main__.py

@@ -0,0 +1,6 @@
+def main():
+    from rift_tui.main import run
+    run()
+
+if __name__ == "__main__":
+    main()