riotskillissue 0.1.3__tar.gz → 0.1.4__tar.gz

{riotskillissue-0.1.3 → riotskillissue-0.1.4}/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.4] - 2026-02-06
+### Added
+- **TUI**: Initial Terminal User Interface functionality for monitoring and interaction.
+
+### Changed
+- **License**: Switched project license to MIT License.
+
 ## [0.1.3] - 2026-02-03
 ### Added
 - **Documentation**: Complete MkDocs Material documentation site with LoL-inspired theme.

riotskillissue-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Demoen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{riotskillissue-0.1.3 → riotskillissue-0.1.4}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: riotskillissue
-Version: 0.1.3
+Version: 0.1.4
 Summary: Production-ready, auto-updating Riot API wrapper.
 Author: Demoen
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -20,7 +20,10 @@ Requires-Dist: jinja2>=3.1.0
 Requires-Dist: msgspec>=0.18.0
 Requires-Dist: pydantic>=2.7.0
 Requires-Dist: redis>=5.0.0
+Requires-Dist: rich>=13.7.0
 Requires-Dist: tenacity>=8.2.0
+Requires-Dist: textual>=0.85.0
+Requires-Dist: typer>=0.12.0
 Provides-Extra: dev
 Requires-Dist: deepdiff>=6.0.0; extra == 'dev'
 Requires-Dist: mypy>=1.10.0; extra == 'dev'
@@ -28,9 +31,8 @@ Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
 Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
 Requires-Dist: pytest>=8.0.0; extra == 'dev'
 Requires-Dist: respx>=0.21.0; extra == 'dev'
-Requires-Dist: rich>=13.7.0; extra == 'dev'
 Requires-Dist: ruff>=0.4.0; extra == 'dev'
-Requires-Dist: typer>=0.12.0; extra == 'dev'
+Requires-Dist: textual-dev>=1.0.0; extra == 'dev'
 Requires-Dist: types-redis; extra == 'dev'
 Requires-Dist: types-requests; extra == 'dev'
 Provides-Extra: docs

{riotskillissue-0.1.3 → riotskillissue-0.1.4}/docs/cli.md

@@ -88,6 +88,49 @@ Game Mode: CLASSIC
 Duration: 1847s
 ```
 
+### live
+
+🎮 Launch an interactive Live Game TUI (Terminal User Interface) that shows real-time information about an ongoing League of Legends match.
+
+```bash
+riotskillissue-cli live "GameName#TagLine" --region euw1
+```
+
+This is the fastest way to spectate a match from your terminal — **one command, instant dashboard**.
+
+**Arguments:**
+
+| Argument | Description |
+|----------|-------------|
+| `name` | Riot ID in format `GameName#TagLine` |
+| `--region` | Regional server (default: `euw1`) |
+| `--api-key` | API key (or use `RIOT_API_KEY` env var) |
+| `--refresh` | Auto-refresh interval in seconds (default: `30`) |
+
+**Example:**
+
+```bash
+$ riotskillissue-cli live "Agurin#EUW" --region euw1
+```
+
+This opens a full-screen terminal dashboard showing:
+
+- **Game info** — queue type, game duration, platform
+- **Blue Team** — champions, player names, ranks, win rates, summoner spells
+- **Red Team** — champions, player names, ranks, win rates, summoner spells  
+- **Bans** — all banned champions
+
+The TUI auto-refreshes every 30 seconds (configurable with `--refresh`). If the player isn't in a game yet, it will keep checking until one starts.
+
+**Keyboard shortcuts:**
+
+| Key | Action |
+|-----|--------|
+| `R` | Manual refresh |
+| `Q` / `Esc` | Quit |
+
+See the [Live Game TUI](live-game-tui.md) page for more details and screenshots.
+
 ## Error Handling
 
 The CLI displays user-friendly error messages:
@@ -103,3 +146,4 @@ $ riotskillissue-cli summoner "NonExistent#USER" --region euw1
 
 Error: 404 - Data not found
 ```
+

riotskillissue-0.1.4/docs/live-game-tui.md

@@ -0,0 +1,238 @@
+# Live Game TUI
+
+RiotSkillIssue includes a built-in **Terminal User Interface** (TUI) for spectating live League of Legends matches directly from your terminal. One command gives you a full dashboard with teams, champions, ranks, and more.
+
+## Quick Start
+
+```bash
+riotskillissue-cli live "Agurin#EUW" --region euw1
+```
+
+That's it. This single command opens an interactive, auto-refreshing dashboard.
+
+## Features
+
+- **Real-time game data** — see the current match as it happens
+- **Both teams at a glance** — champions, summoner spells, ranks, win rates
+- **Auto-refresh** — data updates every 30 seconds (configurable)
+- **Rank colors** — each player's rank is color-coded (Iron → Challenger)
+- **Win rate highlighting** — green for >55%, red for <45%
+- **Ban display** — all banned champions listed
+- **Waiting mode** — if the player isn't in a game, the TUI waits and checks periodically
+- **Keyboard controls** — refresh manually or quit with a single keypress
+
+## Installation
+
+The TUI is included with the standard package installation:
+
+```bash
+pip install riotskillissue
+```
+
+!!! note "Dependencies"
+    The TUI uses [Textual](https://textual.textualize.io/) and [Rich](https://rich.readthedocs.io/), 
+    which are installed automatically as dependencies.
+
+## Usage
+
+### Basic
+
+```bash
+export RIOT_API_KEY="RGAPI-your-key-here"
+riotskillissue-cli live "GameName#TagLine"
+```
+
+### With Options
+
+```bash
+riotskillissue-cli live "Faker#KR1" --region kr --refresh 15
+```
+
+### All Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `name` | *(required)* | Riot ID in `GameName#TagLine` format |
+| `--region` | `euw1` | Regional server (`euw1`, `na1`, `kr`, `eun1`, etc.) |
+| `--api-key` | `$RIOT_API_KEY` | Riot API key |
+| `--refresh` | `30` | Auto-refresh interval in seconds |
+
+### Regions
+
+All standard League of Legends regions are supported:
+
+| Region | Code |
+|--------|------|
+| North America | `na1` |
+| Europe West | `euw1` |
+| Europe Nordic & East | `eun1` |
+| Korea | `kr` |
+| Japan | `jp1` |
+| Brazil | `br1` |
+| Latin America North | `la1` |
+| Latin America South | `la2` |
+| Oceania | `oc1` |
+| Turkey | `tr1` |
+| Russia | `ru` |
+| Philippines | `ph2` |
+| Singapore | `sg2` |
+| Thailand | `th2` |
+| Taiwan | `tw2` |
+| Vietnam | `vn2` |
+
+## Keyboard Shortcuts
+
+| Key | Action |
+|-----|--------|
+| ++r++ | Refresh game data immediately |
+| ++q++ | Quit the TUI |
+| ++escape++ | Quit the TUI |
+
+## What You See
+
+### When a Game is Active
+
+The TUI displays a full-screen dashboard with:
+
+```
+┌─────────────────────────────────────────────────────────────┐
+│            🎮  LIVE GAME  —  Ranked Solo/Duo                │
+│            ⏱  12:34    📍  EUW1                             │
+├─────────────────────────────────────────────────────────────┤
+│                    🔵  BLUE TEAM                            │
+│  Champion    │ Player       │ Rank           │ Spells       │
+│──────────────┼──────────────┼────────────────┼──────────────│
+│  Ahri        │ Player1#EUW  │ Diamond II     │ Flash / Ign  │
+│  Lee Sin     │ Player2#EUW  │ Emerald I      │ Flash / Smt  │
+│  Orianna     │ Player3#EUW  │ Master 234 LP  │ Flash / TP   │
+│  Jinx        │ Player4#EUW  │ Diamond IV     │ Flash / Heal │
+│  Thresh      │ Player5#EUW  │ Platinum I     │ Flash / Ign  │
+├─────────────────────────────────────────────────────────────┤
+│  🚫 Bans: Yasuo · Yone · Zed · Lux · Blitzcrank            │
+├─────────────────────────────────────────────────────────────┤
+│                    🔴  RED TEAM                             │
+│  Champion    │ Player       │ Rank           │ Spells       │
+│──────────────┼──────────────┼────────────────┼──────────────│
+│  Zed         │ Player6#EUW  │ Diamond I      │ Flash / Ign  │
+│  Graves      │ Player7#EUW  │ Emerald III    │ Flash / Smt  │
+│  Syndra      │ Player8#EUW  │ Diamond III    │ Flash / TP   │
+│  Kai'Sa      │ Player9#EUW  │ Platinum II    │ Flash / Heal │
+│  Nautilus    │ Player10#EUW │ Diamond IV     │ Flash / Ign  │
+└─────────────────────────────────────────────────────────────┘
+  Q Quit │ R Refresh │ Auto-refresh: 24s
+```
+
+### When Not in a Game
+
+If the player isn't currently in a match, the TUI shows a waiting screen and keeps checking:
+
+```
+┌───────────────────────────────────────┐
+│                                       │
+│     🎮  Agurin#EUW                    │
+│                                       │
+│     Not currently in a game.          │
+│                                       │
+│     The TUI will auto-refresh and     │
+│     show the game once it starts.     │
+│                                       │
+│     Next refresh in 24s               │
+│     Press [R] to refresh now          │
+│                                       │
+└───────────────────────────────────────┘
+```
+
+## Rank Colors
+
+Each player's rank is displayed with a color matching their tier:
+
+| Tier | Color |
+|------|-------|
+| Iron | Gray |
+| Bronze | Bronze |
+| Silver | Silver |
+| Gold | Gold |
+| Platinum | Teal |
+| Emerald | Green |
+| Diamond | Light Blue |
+| Master | Purple |
+| Grandmaster | Red |
+| Challenger | Orange |
+
+## Programmatic Usage
+
+You can also launch the TUI from Python code:
+
+```python
+from riotskillissue.tui import run_tui
+
+run_tui(
+    api_key="RGAPI-your-key",
+    game_name="Agurin",
+    tag_line="EUW",
+    region="euw1",
+    auto_refresh=30,
+)
+```
+
+Or use the lower-level app class for more control:
+
+```python
+from riotskillissue.tui import LiveGameApp
+
+app = LiveGameApp(
+    api_key="RGAPI-your-key",
+    game_name="Agurin",
+    tag_line="EUW",
+    region="euw1",
+    auto_refresh=15,
+)
+app.run()
+```
+
+## API Key
+
+The TUI requires a valid Riot API key. You can get one from the [Riot Developer Portal](https://developer.riotgames.com/).
+
+Set it as an environment variable for convenience:
+
+=== "Linux / macOS"
+
+    ```bash
+    export RIOT_API_KEY="RGAPI-your-key-here"
+    ```
+
+=== "Windows (PowerShell)"
+
+    ```powershell
+    $env:RIOT_API_KEY = "RGAPI-your-key-here"
+    ```
+
+=== "Windows (CMD)"
+
+    ```cmd
+    set RIOT_API_KEY=RGAPI-your-key-here
+    ```
+
+!!! tip "Development Keys"
+    Riot development API keys expire every 24 hours. For persistent usage, 
+    apply for a personal or production key through the Developer Portal.
+
+## Troubleshooting
+
+### "Not currently in a game"
+
+The player must be in an **active** League of Legends match (loading screen or in-game). 
+Champion select does not count — the Spectator API only reports data once the game has started.
+
+### "404 - Data not found"
+
+- Double-check the Riot ID spelling and tag line
+- Make sure you're using the correct `--region` for the player's server
+- Verify your API key is valid and not expired
+
+### Rate Limiting
+
+The TUI makes multiple API calls per refresh (spectator + ranks for all 10 players). 
+With a development key (20 requests/second, 100 requests/2 minutes), the default 
+30-second refresh interval stays well within limits. Lower the interval with caution.

{riotskillissue-0.1.3 → riotskillissue-0.1.4}/mkdocs.yml

@@ -71,6 +71,7 @@ nav:
       - VALORANT: examples/valorant.md
   - API Reference: api-reference.md
   - CLI: cli.md
+  - Live Game TUI: live-game-tui.md
   - Contributing: CONTRIBUTING.md
 
 extra:

{riotskillissue-0.1.3 → riotskillissue-0.1.4}/pyproject.toml

@@ -7,7 +7,7 @@ riotskillissue-cli = "riotskillissue.cli:main"
 
 [project]
 name = "riotskillissue"
-version = "0.1.3"
+version = "0.1.4"
 description = "Production-ready, auto-updating Riot API wrapper."
 readme = "README.md"
 authors = [{ name = "Demoen" }]
@@ -20,11 +20,14 @@ dependencies = [
     "jinja2>=3.1.0",
     "frozendict>=2.4.0",  # For immutable specs
     "msgspec>=0.18.0",    # Fast JSON parsing for large specs
+    "typer>=0.12.0",      # CLI framework
+    "rich>=13.7.0",       # Rich text formatting
+    "textual>=0.85.0",    # Terminal User Interface
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -41,11 +44,10 @@ dev = [
     "respx>=0.21.0",
     "ruff>=0.4.0",
     "mypy>=1.10.0",
-    "typer>=0.12.0",     # For CLI tools
-    "rich>=13.7.0",      # For pretty CLI output
     "types-redis",
     "types-requests",
     "deepdiff>=6.0.0",
+    "textual-dev>=1.0.0", # TUI development tools
 ]
 
 docs = [

{riotskillissue-0.1.3 → riotskillissue-0.1.4}/src/riotskillissue/cli.py

@@ -6,7 +6,10 @@ from rich import print as rprint
 from .core.client import RiotClient, RiotClientConfig
 from .core.types import Region
 
-app = typer.Typer(help="RiotSkillIssue API Wrapper CLI")
+app = typer.Typer(
+    help="RiotSkillIssue API Wrapper CLI",
+    rich_markup_mode="rich",
+)
 console = Console()
 
 @app.command()
@@ -80,5 +83,58 @@ def match(match_id: str, region: str = "americas", api_key: str = typer.Option(N
                 
     asyncio.run(_run())
 
+
+@app.command()
+def live(
+    name: str = typer.Argument(
+        ...,
+        help='Riot ID in format "GameName#TagLine" (e.g. "Agurin#EUW")',
+    ),
+    region: str = typer.Option(
+        "euw1",
+        help="Regional server (e.g. euw1, na1, kr)",
+    ),
+    api_key: str = typer.Option(
+        None,
+        envvar="RIOT_API_KEY",
+        help="Riot API key (or set RIOT_API_KEY env var)",
+    ),
+    refresh: int = typer.Option(
+        30,
+        help="Auto-refresh interval in seconds",
+    ),
+):
+    """🎮 Launch the Live Game TUI for a League of Legends match.
+
+    Shows a real-time terminal dashboard with both teams, champion picks,
+    summoner spells, ranks, and win rates. Auto-refreshes periodically.
+
+    \b
+    Examples:
+        riotskillissue-cli live "Agurin#EUW" --region euw1
+        riotskillissue-cli live "Faker#KR1" --region kr
+        riotskillissue-cli live "Player#NA1" --region na1 --refresh 15
+    """
+    if not api_key:
+        rprint("[red]Error: API key required. Set RIOT_API_KEY env var or use --api-key.[/red]")
+        raise typer.Exit(code=1)
+
+    if "#" not in name:
+        rprint('[red]Error: Name must be in format "GameName#TagLine" (e.g. "Agurin#EUW").[/red]')
+        raise typer.Exit(code=1)
+
+    game_name, tag_line = name.split("#", 1)
+
+    from .tui import run_tui
+
+    run_tui(
+        api_key=api_key,
+        game_name=game_name,
+        tag_line=tag_line,
+        region=region,
+        auto_refresh=refresh,
+    )
+
+
 def main():
     app()