riotskillissue 0.1.0__tar.gz → 0.1.1__tar.gz

{riotskillissue-0.1.0 → riotskillissue-0.1.1}/.github/workflows/publish.yml

@@ -15,12 +15,18 @@ jobs:
       name: pypi
       url: https://pypi.org/p/riotskillissue
     permissions:
-      contents: read
+      contents: write
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
 
     steps:
       - uses: actions/checkout@v4
       
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          make_latest: true
+      
       - name: Set up Python
         uses: actions/setup-python@v5
         with:

riotskillissue-0.1.1/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+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.0] - 2025-12-29
+### Added
+- Initial release of `riotskillissue`.
+- **Core**: Resilient `RiotClient` with `HttpClient`, `RedisCache`, and `RedisRateLimiter`.
+- **API**: Full coverage for League of Legends, TFT, LoR, and VALORANT (generated from Spec).
+- **CLI**: `riotskillissue-cli` for quick lookups and debugging.
+- **Auth**: Riot Sign-On (RSO) OAuth2 helper.
+- **Pagination**: Async iterator `paginate()` for paginated endpoints.
+- **Static**: `DataDragonClient` for fetching versions and assets.

riotskillissue-0.1.1/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: riotskillissue
+Version: 0.1.1
+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'
+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)
+
+**The production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.**
+
+[Features](#-features) • [Installation](#-installation) • [Quickstart](#-quickstart) • [Documentation](#-documentation) • [Contributing](docs/CONTRIBUTING.md)
+
+</div>
+
+---
+
+## 🚀 Features
+
+- **🛡️ Type-Safe**: 100% Pydantic models for all requests and responses. No more dictionary guessing.
+- **🔄 Auto-Updated**: Generated weekly from the [Official OpenAPI Spec](https://github.com/MingweiSamuel/riotapi-schema). Supports LoL, TFT, LoR, and VALORANT.
+- **⚡ Resilient by Design**: Built-in exponential backoff, circuit breakers, and correct `Retry-After` handling.
+- **🌍 Distributed**: Pluggable **Redis** support for shared Rate Limiting and Caching across multiple processes.
+- **🛠️ Developer Friendly**: Includes a powerful CLI, smart pagination helpers, and RSO (OAuth2) support.
+
+## 📦 Installation
+
+Requires **Python 3.8+**.
+
+```bash
+pip install riotskillissue
+```
+
+*Or install with extra dev dependencies:*
+```bash
+pip install "riotskillissue[dev]"
+```
+
+## ⚡ Quickstart
+
+```python
+import asyncio
+from riotskillissue import RiotClient, Region
+
+async def main():
+    # 1. Initialize Client (Auto-loads RIOT_API_KEY from env)
+    async with RiotClient() as client:
+    
+        # 2. Type-Safe API Calls
+        summoner = await client.summoner.get_by_puuid(
+             region=Region.NA1,
+             encryptedPUUID="<YOUR_PUUID>"
+        )
+        print(f"Summoner Level: {summoner.summonerLevel}")
+        
+        # 3. Smart Pagination (Async Iterator)
+        from riotskillissue import paginate
+        async for match_id in paginate(client.match.get_ids_by_puuid, puuid=summoner.puuid, count=20):
+             print(f"Match: {match_id}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## 🛠 Configuration
+
+Define your configuration using `RiotClientConfig` or environment variables.
+
+| Parameter | Environment Variable | Default | Description |
+| :--- | :--- | :--- | :--- |
+| **API Key** | `RIOT_API_KEY` | `None` | Your Riot Games API Key. |
+| **Redis URL** | - | `None` | `redis://host:port` for distributed limits. |
+| **Max Retries** | - | `3` | Retries for 5xx/Network errors. |
+| **Timeout** | - | `5s`/`10s` | Connect/Read timeouts. |
+
+```python
+config = RiotClientConfig(
+    api_key="RGAPI-...",
+    redis_url="redis://localhost:6379/0", # Enables distributed rate limiting
+    max_retries=5
+)
+async with RiotClient(config=config) as client:
+    ...
+```
+
+## 🧠 Advanced Usage
+
+### Caching
+Reduce your API calls with built-in caching.
+
+```python
+from riotskillissue.core.cache import RedisCache
+
+cache = RedisCache("redis://localhost:6379/1")
+async with RiotClient(cache=cache) as client:
+    # Requests are now cached!
+    ...
+```
+
+### Data Dragon (Static Data)
+Fetch champions, items, and versions without hassle.
+
+```python
+# Automatically picks the latest version and caches the result
+annie = await client.static.get_champion(1)
+print(annie["name"])  # "Annie"
+```
+
+### CLI Tool
+Debug your API keys or look up players instantly from the terminal.
+
+```bash
+$ riotskillissue-cli summoner "Faker#SKT" --region kr
+{
+  "id": "...",
+  "accountId": "...",
+  "puuid": "...",
+  "name": "Faker",
+  "profileIconId": 6,
+  "revisionDate": 1703894832000,
+  "summonerLevel": 678
+}
+```
+
+## ⚖️ Legal
+
+`riotskillissue` isn't endorsed by Riot Games and doesn't 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.1/README.md

@@ -0,0 +1,131 @@
+# 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)
+
+**The production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.**
+
+[Features](#-features) • [Installation](#-installation) • [Quickstart](#-quickstart) • [Documentation](#-documentation) • [Contributing](docs/CONTRIBUTING.md)
+
+</div>
+
+---
+
+## 🚀 Features
+
+- **🛡️ Type-Safe**: 100% Pydantic models for all requests and responses. No more dictionary guessing.
+- **🔄 Auto-Updated**: Generated weekly from the [Official OpenAPI Spec](https://github.com/MingweiSamuel/riotapi-schema). Supports LoL, TFT, LoR, and VALORANT.
+- **⚡ Resilient by Design**: Built-in exponential backoff, circuit breakers, and correct `Retry-After` handling.
+- **🌍 Distributed**: Pluggable **Redis** support for shared Rate Limiting and Caching across multiple processes.
+- **🛠️ Developer Friendly**: Includes a powerful CLI, smart pagination helpers, and RSO (OAuth2) support.
+
+## 📦 Installation
+
+Requires **Python 3.8+**.
+
+```bash
+pip install riotskillissue
+```
+
+*Or install with extra dev dependencies:*
+```bash
+pip install "riotskillissue[dev]"
+```
+
+## ⚡ Quickstart
+
+```python
+import asyncio
+from riotskillissue import RiotClient, Region
+
+async def main():
+    # 1. Initialize Client (Auto-loads RIOT_API_KEY from env)
+    async with RiotClient() as client:
+    
+        # 2. Type-Safe API Calls
+        summoner = await client.summoner.get_by_puuid(
+             region=Region.NA1,
+             encryptedPUUID="<YOUR_PUUID>"
+        )
+        print(f"Summoner Level: {summoner.summonerLevel}")
+        
+        # 3. Smart Pagination (Async Iterator)
+        from riotskillissue import paginate
+        async for match_id in paginate(client.match.get_ids_by_puuid, puuid=summoner.puuid, count=20):
+             print(f"Match: {match_id}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## 🛠 Configuration
+
+Define your configuration using `RiotClientConfig` or environment variables.
+
+| Parameter | Environment Variable | Default | Description |
+| :--- | :--- | :--- | :--- |
+| **API Key** | `RIOT_API_KEY` | `None` | Your Riot Games API Key. |
+| **Redis URL** | - | `None` | `redis://host:port` for distributed limits. |
+| **Max Retries** | - | `3` | Retries for 5xx/Network errors. |
+| **Timeout** | - | `5s`/`10s` | Connect/Read timeouts. |
+
+```python
+config = RiotClientConfig(
+    api_key="RGAPI-...",
+    redis_url="redis://localhost:6379/0", # Enables distributed rate limiting
+    max_retries=5
+)
+async with RiotClient(config=config) as client:
+    ...
+```
+
+## 🧠 Advanced Usage
+
+### Caching
+Reduce your API calls with built-in caching.
+
+```python
+from riotskillissue.core.cache import RedisCache
+
+cache = RedisCache("redis://localhost:6379/1")
+async with RiotClient(cache=cache) as client:
+    # Requests are now cached!
+    ...
+```
+
+### Data Dragon (Static Data)
+Fetch champions, items, and versions without hassle.
+
+```python
+# Automatically picks the latest version and caches the result
+annie = await client.static.get_champion(1)
+print(annie["name"])  # "Annie"
+```
+
+### CLI Tool
+Debug your API keys or look up players instantly from the terminal.
+
+```bash
+$ riotskillissue-cli summoner "Faker#SKT" --region kr
+{
+  "id": "...",
+  "accountId": "...",
+  "puuid": "...",
+  "name": "Faker",
+  "profileIconId": 6,
+  "revisionDate": 1703894832000,
+  "summonerLevel": 678
+}
+```
+
+## ⚖️ Legal
+
+`riotskillissue` isn't endorsed by Riot Games and doesn't 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.0 → riotskillissue-0.1.1}/pyproject.toml

@@ -7,9 +7,10 @@ riotskillissue-cli = "riotskillissue.cli:main"
 
 [project]
 name = "riotskillissue"
-version = "0.1.0"
+version = "0.1.1"
 description = "Production-ready, auto-updating Riot API wrapper."
-authors = [{ name = "Antigravity", email = "bot@example.com" }]
+readme = "README.md"
+authors = [{ name = "Demoen" }]
 requires-python = ">=3.8"
 dependencies = [
     "httpx>=0.27.0",
@@ -23,6 +24,12 @@ dependencies = [
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
 ]
 

riotskillissue-0.1.0/PKG-INFO

@@ -1,29 +0,0 @@
-Metadata-Version: 2.4
-Name: riotskillissue
-Version: 0.1.0
-Summary: Production-ready, auto-updating Riot API wrapper.
-Author-email: Antigravity <bot@example.com>
-License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-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'

riotskillissue-0.1.0/README.md

@@ -1,171 +0,0 @@
-# Riot API Wrapper
-
-Production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.
-
-## 🚀 Features
-
-- **100% Coverage**: Auto-generated from the [Official OpenAPI Spec](https://github.com/MingweiSamuel/riotapi-schema). Supports League of Legends, TFT, LoR, and VALORANT.
-- **Type-Safe**: All requests and responses use **Pydantic** models. No more `KeyError` or dictionary guessing.
-- **Resilient**: Built-in **Exponential Backoff**, **Circuit Breakers** (for 5xx), and **Rate Limiting** (Respects `Retry-After`).
-- **Distributed Ready**: Pluggable **Redis Rate Limiting** (Lua Scripted) and **Caching**.
-- **Developer Experience**: Includes **CLI**, **Smart Pagination**, **Data Dragon** helpers, and **Hooks**.
-
----
-
-## 📦 Installation
-
-This package requires **Python 3.8+**.
-
-```bash
-# Install from source
-pip install -e .
-```
-
----
-
-## ⚡ Quickstart
-
-```python
-import asyncio
-from riotskillissue import RiotClient, Region
-
-async def main():
-    # 1. Initialize Client (Auto-loads RIOT_API_KEY from env)
-    async with RiotClient() as client:
-    
-        # 2. Call API (Type-hinted!)
-        # Automatically converts "getByPUUID" -> "get_by_puuid"
-        summoner = await client.summoner.get_by_puuid(
-             region=Region.NA1,
-             encryptedPUUID="<YOUR_PUUID>"
-        )
-        
-        print(f"Level: {summoner.summonerLevel}")
-        
-        # 3. Match History (with Pagination)
-        from riotskillissue import paginate
-        async for match_id in paginate(client.match.get_ids_by_puuid, puuid=summoner.puuid, count=20):
-             print(f"Match: {match_id}")
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
----
-
-## 🛠 Configuration
-
-The client is highly configurable via `RiotClientConfig`.
-
-```python
-from riotskillissue import RiotClientConfig, RiotClient
-
-config = RiotClientConfig(
-    api_key="RGAPI-...",          # Or set RIOT_API_KEY env var
-    connect_timeout=5.0,          # Initial connection timeout (s)
-    read_timeout=10.0,            # Response read timeout (s)
-    max_retries=3,                # Max attempts for 5xx/Connectivity errors
-    redis_url="redis://localhost" # Enable Distributed Rate Limiting
-)
-```
-
-| Parameter | Type | Default | Description |
-| :--- | :--- | :--- | :--- |
-| `api_key` | `str` | `None` | Riot API Key. Defaults to `os.environ["RIOT_API_KEY"]`. |
-| `redis_url` | `str` | `None` | Connection string for Redis (e.g. `redis://127.0.0.1:6379`). Required for **Distributed Rate Limiting**. |
-| `max_retries` | `int` | `3` | Attempts for network/server errors. |
-| `connect_timeout` | `float` | `5.0` | Headers wait timeout. |
-| `read_timeout` | `float` | `10.0` | Body wait timeout. |
-
----
-
-## 🧠 Advanced Features
-
-### 1. Caching
-Reduce API usage by enabling the caching layer.
-
-```python
-from riotskillissue.core.cache import RedisCache, MemoryCache
-
-# In-Memory (Single Process)
-cache = MemoryCache()
-
-# Redis (Distributed)
-cache = RedisCache("redis://localhost:6379/1")
-
-async with RiotClient(cache=cache) as client:
-    # 200 OK GET requests are cached automatically (Default TTL: 60s)
-    # Static Data is cached longer (versions: 1h, champions: 24h)
-    ...
-```
-
-### 2. Static Data (Data Dragon)
-Auto-fetch champion info without managing version strings.
-
-```python
-# Fetches latest version -> fetches champion.json -> caches it
-annie = await client.static.get_champion(1)
-print(annie["name"]) # "Annie"
-```
-
-### 3. Riot Sign-On (RSO)
-OAuth2 helper for web apps.
-
-```python
-from riotskillissue.auth import RsoClient, RsoConfig
-
-rso = RsoClient(RsoConfig(
-    client_id="...", 
-    client_secret="...", 
-    redirect_uri="http://localhost/callback"
-))
-
-# 1. Redirect user here
-auth_url = rso.get_auth_url() 
-
-# 2. Exchange code for tokens
-tokens = await rso.exchange_code("authorization_code")
-```
-
-### 4. CLI Tool
-Quick debug from terminal.
-
-```bash
-# Basic Lookup
-riotskillissue-cli summoner "Faker#SKT" --region kr
-
-# Match Details
-riotskillissue-cli match "KR_1234567890"
-
-# Help
-riotskillissue-cli --help
-```
-
----
-
-## 🧪 Testing
-
-This repo comes with a comprehensive test suite.
-
-```bash
-# Run all tests (Unit + Integration + Mocked Edge Cases)
-pytest tests/
-
-# Run specific suite
-pytest tests/test_resiliency.py
-```
-
-## 🤖 Automation
-
-How this library stays up to date:
-1. **Weekly Action**: `.github/workflows/update_sdk.yml` runs.
-2. **Fetch**: Downloads `openapi.json` from [MingweiSamuel/riotapi-schema](https://github.com/MingweiSamuel/riotapi-schema).
-3. **Diff**: Compares with current generated definitions.
-4. **Generate**: Re-runs `tools/generator/core.py`.
-5. **PR**: Opens a Pull Request with the changes and a changelog.
-
----
-
-## 📄 License
-
-MIT