riotskillissue 0.1.2__tar.gz → 0.1.3__tar.gz

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

@@ -5,6 +5,25 @@ 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.3] - 2026-02-03
+### Added
+- **Documentation**: Complete MkDocs Material documentation site with LoL-inspired theme.
+- **Documentation**: Getting Started, Configuration, API Reference, and CLI guides.
+- **Documentation**: Comprehensive examples for LoL, TFT, and VALORANT APIs.
+- **Examples**: Runnable example scripts (`basic_usage.py`, `match_history.py`, `champion_mastery.py`).
+
+### Changed
+- **README**: Rewritten for professional presentation.
+- **Dependencies**: Added `docs` optional dependency group for MkDocs.
+
+## [0.1.2] - 2026-01-27
+### Changed
+- **API**: Update Riot API Spec (automated update via GitHub Actions).
+
+## [0.1.1] - 2025-12-29
+### Changed
+- **API**: Update Riot API Spec (automated update via GitHub Actions).
+
 ## [0.1.0] - 2025-12-29
 ### Added
 - Initial release of `riotskillissue`.

riotskillissue-0.1.3/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: riotskillissue
+Version: 0.1.3
+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: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Requires-Dist: frozendict>=2.4.0
+Requires-Dist: httpx>=0.27.0
+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: tenacity>=8.2.0
+Provides-Extra: dev
+Requires-Dist: deepdiff>=6.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+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: types-redis; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# RiotSkillIssue
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/riotskillissue.svg)](https://badge.fury.io/py/riotskillissue)
+[![Python Versions](https://img.shields.io/pypi/pyversions/riotskillissue.svg)](https://pypi.org/project/riotskillissue/)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+[![Tests](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml/badge.svg)](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml)
+
+**Production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.**
+
+[Documentation](https://demoen.github.io/riotskillissue/) · [Examples](https://demoen.github.io/riotskillissue/examples/) · [API Reference](https://demoen.github.io/riotskillissue/api-reference/)
+
+</div>
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Type-Safe** | 100% Pydantic models for all requests and responses |
+| **Auto-Updated** | Generated daily from the Official OpenAPI Spec |
+| **Resilient** | Built-in exponential backoff, circuit breakers, and `Retry-After` handling |
+| **Distributed** | Pluggable Redis support for shared rate limiting and caching |
+| **Multi-Game** | Full support for LoL, TFT, LoR, and VALORANT APIs |
+
+## Installation
+
+Requires Python 3.8+.
+
+```bash
+pip install riotskillissue
+```
+
+## Quick Start
+
+```python
+import asyncio
+from riotskillissue import RiotClient, Platform, Region
+
+async def main():
+    async with RiotClient() as client:
+        # Look up account by Riot ID
+        account = await client.account.get_by_riot_id(
+            region=Platform.EUROPE,
+            gameName="Agurin",
+            tagLine="EUW"
+        )
+        print(f"Found: {account.gameName}#{account.tagLine}")
+        
+        # Get summoner data
+        summoner = await client.summoner.get_by_puuid(
+            region=Region.EUW1,
+            encryptedPUUID=account.puuid
+        )
+        print(f"Level: {summoner.summonerLevel}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Set your API key via environment variable:
+
+```bash
+export RIOT_API_KEY="RGAPI-your-key-here"
+```
+
+Or pass it directly:
+
+```python
+async with RiotClient(api_key="RGAPI-...") as client:
+    ...
+```
+
+## Configuration
+
+```python
+from riotskillissue import RiotClient, RiotClientConfig
+from riotskillissue.core.cache import RedisCache
+
+config = RiotClientConfig(
+    api_key="RGAPI-...",
+    max_retries=5,
+    redis_url="redis://localhost:6379/0"  # Distributed rate limiting
+)
+
+cache = RedisCache("redis://localhost:6379/1")
+
+async with RiotClient(config=config, cache=cache) as client:
+    ...
+```
+
+## Documentation
+
+Full documentation is available at [demoen.github.io/riotskillissue](https://demoen.github.io/riotskillissue/).
+
+- [Getting Started](https://demoen.github.io/riotskillissue/getting-started/)
+- [Configuration](https://demoen.github.io/riotskillissue/configuration/)
+- [Examples](https://demoen.github.io/riotskillissue/examples/)
+- [API Reference](https://demoen.github.io/riotskillissue/api-reference/)
+- [CLI](https://demoen.github.io/riotskillissue/cli/)
+
+## Legal
+
+RiotSkillIssue is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. Riot Games and all associated properties are trademarks or registered trademarks of Riot Games, Inc.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.

riotskillissue-0.1.3/README.md

@@ -0,0 +1,110 @@
+# RiotSkillIssue
+
+<div align="center">
+
+[![PyPI version](https://badge.fury.io/py/riotskillissue.svg)](https://badge.fury.io/py/riotskillissue)
+[![Python Versions](https://img.shields.io/pypi/pyversions/riotskillissue.svg)](https://pypi.org/project/riotskillissue/)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
+[![Tests](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml/badge.svg)](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml)
+
+**Production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.**
+
+[Documentation](https://demoen.github.io/riotskillissue/) · [Examples](https://demoen.github.io/riotskillissue/examples/) · [API Reference](https://demoen.github.io/riotskillissue/api-reference/)
+
+</div>
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Type-Safe** | 100% Pydantic models for all requests and responses |
+| **Auto-Updated** | Generated daily from the Official OpenAPI Spec |
+| **Resilient** | Built-in exponential backoff, circuit breakers, and `Retry-After` handling |
+| **Distributed** | Pluggable Redis support for shared rate limiting and caching |
+| **Multi-Game** | Full support for LoL, TFT, LoR, and VALORANT APIs |
+
+## Installation
+
+Requires Python 3.8+.
+
+```bash
+pip install riotskillissue
+```
+
+## Quick Start
+
+```python
+import asyncio
+from riotskillissue import RiotClient, Platform, Region
+
+async def main():
+    async with RiotClient() as client:
+        # Look up account by Riot ID
+        account = await client.account.get_by_riot_id(
+            region=Platform.EUROPE,
+            gameName="Agurin",
+            tagLine="EUW"
+        )
+        print(f"Found: {account.gameName}#{account.tagLine}")
+        
+        # Get summoner data
+        summoner = await client.summoner.get_by_puuid(
+            region=Region.EUW1,
+            encryptedPUUID=account.puuid
+        )
+        print(f"Level: {summoner.summonerLevel}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+Set your API key via environment variable:
+
+```bash
+export RIOT_API_KEY="RGAPI-your-key-here"
+```
+
+Or pass it directly:
+
+```python
+async with RiotClient(api_key="RGAPI-...") as client:
+    ...
+```
+
+## Configuration
+
+```python
+from riotskillissue import RiotClient, RiotClientConfig
+from riotskillissue.core.cache import RedisCache
+
+config = RiotClientConfig(
+    api_key="RGAPI-...",
+    max_retries=5,
+    redis_url="redis://localhost:6379/0"  # Distributed rate limiting
+)
+
+cache = RedisCache("redis://localhost:6379/1")
+
+async with RiotClient(config=config, cache=cache) as client:
+    ...
+```
+
+## Documentation
+
+Full documentation is available at [demoen.github.io/riotskillissue](https://demoen.github.io/riotskillissue/).
+
+- [Getting Started](https://demoen.github.io/riotskillissue/getting-started/)
+- [Configuration](https://demoen.github.io/riotskillissue/configuration/)
+- [Examples](https://demoen.github.io/riotskillissue/examples/)
+- [API Reference](https://demoen.github.io/riotskillissue/api-reference/)
+- [CLI](https://demoen.github.io/riotskillissue/cli/)
+
+## Legal
+
+RiotSkillIssue is not endorsed by Riot Games and does not reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. Riot Games and all associated properties are trademarks or registered trademarks of Riot Games, Inc.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.

riotskillissue-0.1.3/docs/api-reference.md

@@ -0,0 +1,292 @@
+# API Reference
+
+Complete reference for all available API endpoints.
+
+## Client Initialization
+
+```python
+from riotskillissue import RiotClient, RiotClientConfig
+
+# Simple initialization (uses RIOT_API_KEY env var)
+async with RiotClient() as client:
+    pass
+
+# With explicit API key
+async with RiotClient(api_key="RGAPI-...") as client:
+    pass
+
+# With full configuration
+config = RiotClientConfig(
+    api_key="RGAPI-...",
+    max_retries=5,
+    redis_url="redis://localhost:6379/0"
+)
+async with RiotClient(config=config) as client:
+    pass
+```
+
+---
+
+## Region and Platform Types
+
+```python
+from riotskillissue import Region, Platform
+```
+
+### Platform (Routing)
+
+Used for account lookups and match history APIs.
+
+| Value | Description |
+|-------|-------------|
+| `Platform.AMERICAS` | North/South America |
+| `Platform.EUROPE` | Europe |
+| `Platform.ASIA` | Korea, Japan |
+| `Platform.SEA` | Southeast Asia, Oceania |
+
+### Region (Server)
+
+Used for summoner, ranked, and spectator APIs.
+
+| Value | Server |
+|-------|--------|
+| `Region.NA1` | North America |
+| `Region.EUW1` | Europe West |
+| `Region.EUN1` | Europe Nordic & East |
+| `Region.KR` | Korea |
+| `Region.BR1` | Brazil |
+| `Region.LA1` | Latin America North |
+| `Region.LA2` | Latin America South |
+| `Region.OC1` | Oceania |
+| `Region.JP1` | Japan |
+| `Region.TR1` | Turkey |
+| `Region.RU` | Russia |
+| `Region.PH2` | Philippines |
+| `Region.SG2` | Singapore |
+| `Region.TH2` | Thailand |
+| `Region.TW2` | Taiwan |
+| `Region.VN2` | Vietnam |
+
+---
+
+## League of Legends APIs
+
+### Account API
+
+`client.account`
+
+| Method | Description |
+|--------|-------------|
+| `get_by_puuid(region, puuid)` | Get account by PUUID |
+| `get_by_riot_id(region, gameName, tagLine)` | Get account by Riot ID |
+| `get_by_access_token(region)` | Get account using RSO token |
+| `get_active_shard(region, game, puuid)` | Get active shard for player |
+
+### Summoner API
+
+`client.summoner`
+
+| Method | Description |
+|--------|-------------|
+| `get_by_puuid(region, encryptedPUUID)` | Get summoner by PUUID |
+| `get_by_access_token(region)` | Get summoner using RSO token |
+
+### Match API
+
+`client.match`
+
+| Method | Description |
+|--------|-------------|
+| `get_match_ids_by_puuid(region, puuid, ...)` | Get list of match IDs |
+| `get_match(region, matchId)` | Get match details |
+| `get_timeline(region, matchId)` | Get match timeline |
+| `get_replay(region, puuid)` | Get player replays |
+
+Optional parameters for `get_match_ids_by_puuid`:
+
+- `count` - Number of matches (default: 20, max: 100)
+- `start` - Offset for pagination
+- `startTime` / `endTime` - Time filters (epoch seconds)
+- `queue` - Queue ID filter
+- `type` - Game type filter
+
+### Champion Mastery API
+
+`client.champion_mastery`
+
+| Method | Description |
+|--------|-------------|
+| `get_all_masteries(region, encryptedPUUID)` | Get all champion masteries |
+| `get_by_champion(region, encryptedPUUID, championId)` | Get mastery for champion |
+| `get_top_masteries(region, encryptedPUUID, count)` | Get top N masteries |
+| `get_mastery_score(region, encryptedPUUID)` | Get total mastery score |
+
+### League API
+
+`client.league`
+
+| Method | Description |
+|--------|-------------|
+| `get_entries_by_summoner(region, encryptedSummonerId)` | Get ranked entries |
+| `get_challenger_league(region, queue)` | Get challenger league |
+| `get_grandmaster_league(region, queue)` | Get grandmaster league |
+| `get_master_league(region, queue)` | Get master league |
+
+### Spectator API
+
+`client.spectator`
+
+| Method | Description |
+|--------|-------------|
+| `get_current_game_info(region, encryptedPUUID)` | Get live game data |
+| `get_featured_games(region)` | Get featured games |
+
+### Champion API
+
+`client.champion`
+
+| Method | Description |
+|--------|-------------|
+| `get_champion_rotations(region)` | Get free champion rotation |
+
+### Status API
+
+`client.lol_status`
+
+| Method | Description |
+|--------|-------------|
+| `get_platform_data(region)` | Get platform status |
+
+---
+
+## TFT APIs
+
+### TFT Summoner API
+
+`client.tft_summoner`
+
+| Method | Description |
+|--------|-------------|
+| `get_by_puuid(region, encryptedPUUID)` | Get TFT summoner by PUUID |
+
+### TFT Match API
+
+`client.tft_match`
+
+| Method | Description |
+|--------|-------------|
+| `get_match_ids_by_puuid(region, puuid, count)` | Get TFT match IDs |
+| `get_match(region, matchId)` | Get TFT match details |
+
+### TFT League API
+
+`client.tft_league`
+
+| Method | Description |
+|--------|-------------|
+| `get_challenger_league(region)` | Get TFT challenger league |
+| `get_grandmaster_league(region)` | Get TFT grandmaster league |
+| `get_master_league(region)` | Get TFT master league |
+| `get_entries_by_summoner(region, summonerId)` | Get ranked entries |
+
+### TFT Status API
+
+`client.tft_status`
+
+| Method | Description |
+|--------|-------------|
+| `get_platform_data(region)` | Get TFT platform status |
+
+---
+
+## VALORANT APIs
+
+### VALORANT Content API
+
+`client.val_content`
+
+| Method | Description |
+|--------|-------------|
+| `get_content(region, locale)` | Get game content (agents, maps, etc.) |
+
+### VALORANT Ranked API
+
+`client.val_ranked`
+
+| Method | Description |
+|--------|-------------|
+| `get_leaderboard(region, actId, ...)` | Get ranked leaderboard |
+
+### VALORANT Status API
+
+`client.val_status`
+
+| Method | Description |
+|--------|-------------|
+| `get_platform_data(region)` | Get VALORANT platform status |
+
+---
+
+## Legends of Runeterra APIs
+
+### LoR Match API
+
+`client.lor_match`
+
+| Method | Description |
+|--------|-------------|
+| `get_match_ids_by_puuid(region, puuid)` | Get LoR match IDs |
+| `get_match(region, matchId)` | Get LoR match details |
+
+### LoR Ranked API
+
+`client.lor_ranked`
+
+| Method | Description |
+|--------|-------------|
+| `get_leaderboards(region)` | Get LoR leaderboards |
+
+### LoR Status API
+
+`client.lor_status`
+
+| Method | Description |
+|--------|-------------|
+| `get_platform_data(region)` | Get LoR platform status |
+
+---
+
+## Static Data (Data Dragon)
+
+`client.static`
+
+| Method | Description |
+|--------|-------------|
+| `get_latest_version()` | Get latest Data Dragon version |
+| `get_champion(champion_key)` | Get champion data by ID |
+| `get_item(item_id)` | Get item data by ID |
+
+---
+
+## Pagination Helper
+
+```python
+from riotskillissue import paginate
+
+async for match_id in paginate(
+    client.match.get_match_ids_by_puuid,
+    region=Platform.EUROPE,
+    puuid="...",
+    count=100,       # Items per page
+    max_results=500  # Total items to fetch
+):
+    print(match_id)
+```
+
+| Parameter | Description |
+|-----------|-------------|
+| `method` | The API method to paginate |
+| `start` | Initial offset (default: 0) |
+| `count` | Items per page (default: 100) |
+| `max_results` | Maximum items to yield (default: infinity) |
+| `**kwargs` | Arguments passed to the method |

riotskillissue-0.1.3/docs/cli.md

@@ -0,0 +1,105 @@
+# Command Line Interface
+
+RiotSkillIssue includes a CLI tool for quick lookups and debugging.
+
+## Installation
+
+The CLI is included with the package:
+
+```bash
+pip install riotskillissue
+```
+
+For enhanced output formatting, install with dev dependencies:
+
+```bash
+pip install "riotskillissue[dev]"
+```
+
+## Configuration
+
+Set your API key via environment variable:
+
+```bash
+export RIOT_API_KEY="RGAPI-your-key-here"
+```
+
+Or pass it directly with `--api-key`:
+
+```bash
+riotskillissue-cli summoner "Player#EUW" --api-key "RGAPI-..."
+```
+
+## Commands
+
+### summoner
+
+Look up a summoner by Riot ID.
+
+```bash
+riotskillissue-cli summoner "GameName#TagLine" --region euw1
+```
+
+**Arguments:**
+
+| Argument | Description |
+|----------|-------------|
+| `name` | Riot ID in format `GameName#TagLine` |
+| `--region` | Regional server (default: `na1`) |
+| `--api-key` | API key (or use `RIOT_API_KEY` env var) |
+
+**Example:**
+
+```bash
+$ riotskillissue-cli summoner "Agurin#EUW" --region euw1
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃     Summoner: Agurin#EUW         ┃
+┣━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┫
+┃ Level     │ PUUID                 ┃
+┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩
+│ 523       │ abc123...             │
+└───────────┴───────────────────────┘
+```
+
+### match
+
+Get match details by match ID.
+
+```bash
+riotskillissue-cli match "EUW1_7654321098" --region europe
+```
+
+**Arguments:**
+
+| Argument | Description |
+|----------|-------------|
+| `match_id` | Match ID (e.g., `EUW1_7654321098`) |
+| `--region` | Platform routing (default: `americas`) |
+| `--api-key` | API key (or use `RIOT_API_KEY` env var) |
+
+**Example:**
+
+```bash
+$ riotskillissue-cli match "EUW1_7654321098" --region europe
+
+Match EUW1_7654321098 loaded!
+Game Mode: CLASSIC
+Duration: 1847s
+```
+
+## Error Handling
+
+The CLI displays user-friendly error messages:
+
+```bash
+$ riotskillissue-cli summoner "InvalidName"
+
+Error: Name must be format GameName#TagLine for Account V1 lookup
+```
+
+```bash
+$ riotskillissue-cli summoner "NonExistent#USER" --region euw1
+
+Error: 404 - Data not found
+```