riotskillissue 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,152 @@
1
+ Metadata-Version: 2.4
2
+ Name: riotskillissue
3
+ Version: 0.1.4
4
+ Summary: Production-ready, auto-updating Riot API wrapper.
5
+ Author: Demoen
6
+ License-File: LICENSE
7
+ Classifier: Development Status :: 4 - Beta
8
+ Classifier: Intended Audience :: Developers
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Programming Language :: Python :: 3.8
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Requires-Python: >=3.8
17
+ Requires-Dist: frozendict>=2.4.0
18
+ Requires-Dist: httpx>=0.27.0
19
+ Requires-Dist: jinja2>=3.1.0
20
+ Requires-Dist: msgspec>=0.18.0
21
+ Requires-Dist: pydantic>=2.7.0
22
+ Requires-Dist: redis>=5.0.0
23
+ Requires-Dist: rich>=13.7.0
24
+ Requires-Dist: tenacity>=8.2.0
25
+ Requires-Dist: textual>=0.85.0
26
+ Requires-Dist: typer>=0.12.0
27
+ Provides-Extra: dev
28
+ Requires-Dist: deepdiff>=6.0.0; extra == 'dev'
29
+ Requires-Dist: mypy>=1.10.0; extra == 'dev'
30
+ Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
31
+ Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
32
+ Requires-Dist: pytest>=8.0.0; extra == 'dev'
33
+ Requires-Dist: respx>=0.21.0; extra == 'dev'
34
+ Requires-Dist: ruff>=0.4.0; extra == 'dev'
35
+ Requires-Dist: textual-dev>=1.0.0; extra == 'dev'
36
+ Requires-Dist: types-redis; extra == 'dev'
37
+ Requires-Dist: types-requests; extra == 'dev'
38
+ Provides-Extra: docs
39
+ Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
40
+ Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
41
+ Description-Content-Type: text/markdown
42
+
43
+ # RiotSkillIssue
44
+
45
+ <div align="center">
46
+
47
+ [![PyPI version](https://badge.fury.io/py/riotskillissue.svg)](https://badge.fury.io/py/riotskillissue)
48
+ [![Python Versions](https://img.shields.io/pypi/pyversions/riotskillissue.svg)](https://pypi.org/project/riotskillissue/)
49
+ [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
50
+ [![Tests](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml/badge.svg)](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml)
51
+
52
+ **Production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.**
53
+
54
+ [Documentation](https://demoen.github.io/riotskillissue/) · [Examples](https://demoen.github.io/riotskillissue/examples/) · [API Reference](https://demoen.github.io/riotskillissue/api-reference/)
55
+
56
+ </div>
57
+
58
+ ---
59
+
60
+ ## Features
61
+
62
+ | Feature | Description |
63
+ |---------|-------------|
64
+ | **Type-Safe** | 100% Pydantic models for all requests and responses |
65
+ | **Auto-Updated** | Generated daily from the Official OpenAPI Spec |
66
+ | **Resilient** | Built-in exponential backoff, circuit breakers, and `Retry-After` handling |
67
+ | **Distributed** | Pluggable Redis support for shared rate limiting and caching |
68
+ | **Multi-Game** | Full support for LoL, TFT, LoR, and VALORANT APIs |
69
+
70
+ ## Installation
71
+
72
+ Requires Python 3.8+.
73
+
74
+ ```bash
75
+ pip install riotskillissue
76
+ ```
77
+
78
+ ## Quick Start
79
+
80
+ ```python
81
+ import asyncio
82
+ from riotskillissue import RiotClient, Platform, Region
83
+
84
+ async def main():
85
+ async with RiotClient() as client:
86
+ # Look up account by Riot ID
87
+ account = await client.account.get_by_riot_id(
88
+ region=Platform.EUROPE,
89
+ gameName="Agurin",
90
+ tagLine="EUW"
91
+ )
92
+ print(f"Found: {account.gameName}#{account.tagLine}")
93
+
94
+ # Get summoner data
95
+ summoner = await client.summoner.get_by_puuid(
96
+ region=Region.EUW1,
97
+ encryptedPUUID=account.puuid
98
+ )
99
+ print(f"Level: {summoner.summonerLevel}")
100
+
101
+ if __name__ == "__main__":
102
+ asyncio.run(main())
103
+ ```
104
+
105
+ Set your API key via environment variable:
106
+
107
+ ```bash
108
+ export RIOT_API_KEY="RGAPI-your-key-here"
109
+ ```
110
+
111
+ Or pass it directly:
112
+
113
+ ```python
114
+ async with RiotClient(api_key="RGAPI-...") as client:
115
+ ...
116
+ ```
117
+
118
+ ## Configuration
119
+
120
+ ```python
121
+ from riotskillissue import RiotClient, RiotClientConfig
122
+ from riotskillissue.core.cache import RedisCache
123
+
124
+ config = RiotClientConfig(
125
+ api_key="RGAPI-...",
126
+ max_retries=5,
127
+ redis_url="redis://localhost:6379/0" # Distributed rate limiting
128
+ )
129
+
130
+ cache = RedisCache("redis://localhost:6379/1")
131
+
132
+ async with RiotClient(config=config, cache=cache) as client:
133
+ ...
134
+ ```
135
+
136
+ ## Documentation
137
+
138
+ Full documentation is available at [demoen.github.io/riotskillissue](https://demoen.github.io/riotskillissue/).
139
+
140
+ - [Getting Started](https://demoen.github.io/riotskillissue/getting-started/)
141
+ - [Configuration](https://demoen.github.io/riotskillissue/configuration/)
142
+ - [Examples](https://demoen.github.io/riotskillissue/examples/)
143
+ - [API Reference](https://demoen.github.io/riotskillissue/api-reference/)
144
+ - [CLI](https://demoen.github.io/riotskillissue/cli/)
145
+
146
+ ## Legal
147
+
148
+ 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.
149
+
150
+ ## License
151
+
152
+ This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.
@@ -1,8 +1,9 @@
1
1
  riotskillissue/__init__.py,sha256=CA0b9B2kxezDDPJcxWlXQco6kLn4LfP0c0CxREf6I14,213
2
2
  riotskillissue/auth.py,sha256=K2Soa6sm7RsGxshfGaJPAPVyz4CnSPGR66Xeid0R4aY,2247
3
- riotskillissue/cli.py,sha256=fsZKP81jKYgH1SKQGl5eE0NWpt84TGCT_SktE-ryHBM,3774
3
+ riotskillissue/cli.py,sha256=QvuT877Ft0BJA4ufWouj3jk3gOTu9ecLveno-nExhiE,5287
4
4
  riotskillissue/static.py,sha256=dVwuiKe85hWRrRpS0kfWEQZChioRVyMKlGjWD3mGfvQ,2707
5
5
  riotskillissue/testing.py,sha256=idkJJr8yI_xzufpvRYkB0ovdpFXGXFsEFHNcJj32e_o,1493
6
+ riotskillissue/tui.py,sha256=JQhpE5gtRgnAa5TI19Wul2joqRT23JP9oKvA5bkK0WQ,22433
6
7
  riotskillissue/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
8
  riotskillissue/api/client_mixin.py,sha256=_WuGSuKL7qTq6oOutXhn7bK0qPtDMLGT7gyybkWaY9U,4029
8
9
  riotskillissue/api/models.py,sha256=OA7MJCE-vOabAZyn8CyY90R8naiSCV1DAd8COw53yLo,122628
@@ -68,8 +69,8 @@ riotskillissue/core/pagination.py,sha256=OEiKwBCUt3YhmEQVNujze7k7E9D2cH582NUfOko
68
69
  riotskillissue/core/ratelimit.py,sha256=moCm8ztJWt0tLF6gyJraC68cM8g-Y8KGWvOeEAopkqg,7510
69
70
  riotskillissue/core/types.py,sha256=PUdqAcvraAGQNJHG2jyy0txHM-2_QHXc1Hbp0IMTWc8,1254
70
71
  riotskillissue/core/utils.py,sha256=THNMRbHegLDtHJd0QJ9n4c9T8Jm2l0cQBf0uRAjiC7k,742
71
- riotskillissue-0.1.2.dist-info/METADATA,sha256=Q53Feb7r-HKkFtbWRII8KMXsZePZ-ye8O8YE3oHhOOc,5755
72
- riotskillissue-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
73
- riotskillissue-0.1.2.dist-info/entry_points.txt,sha256=UGwPyhTjcdeyXCvSOAXUzCCRGT2QFV0tbIdjjoFY5rw,63
74
- riotskillissue-0.1.2.dist-info/licenses/LICENSE,sha256=iIq3-s_OspO8VZs4HPK_DS_aPU-kJ0vwYAtQau5nLYY,35175
75
- riotskillissue-0.1.2.dist-info/RECORD,,
72
+ riotskillissue-0.1.4.dist-info/METADATA,sha256=LKLXjqzI0gGDZbi6V3l02erlUWOPAEEpXPTLK64st8Y,5104
73
+ riotskillissue-0.1.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
74
+ riotskillissue-0.1.4.dist-info/entry_points.txt,sha256=UGwPyhTjcdeyXCvSOAXUzCCRGT2QFV0tbIdjjoFY5rw,63
75
+ riotskillissue-0.1.4.dist-info/licenses/LICENSE,sha256=8muQ74nub9fsnm10xwaY8Ktssflk6pX4riAwPvxWbco,1063
76
+ riotskillissue-0.1.4.dist-info/RECORD,,
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Demoen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,168 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: riotskillissue
3
- Version: 0.1.2
4
- Summary: Production-ready, auto-updating Riot API wrapper.
5
- Author: Demoen
6
- License-File: LICENSE
7
- Classifier: Development Status :: 4 - Beta
8
- Classifier: Intended Audience :: Developers
9
- Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
10
- Classifier: Programming Language :: Python :: 3.8
11
- Classifier: Programming Language :: Python :: 3.9
12
- Classifier: Programming Language :: Python :: 3.10
13
- Classifier: Programming Language :: Python :: 3.11
14
- Classifier: Programming Language :: Python :: 3.12
15
- Classifier: Programming Language :: Python :: 3.13
16
- Requires-Python: >=3.8
17
- Requires-Dist: frozendict>=2.4.0
18
- Requires-Dist: httpx>=0.27.0
19
- Requires-Dist: jinja2>=3.1.0
20
- Requires-Dist: msgspec>=0.18.0
21
- Requires-Dist: pydantic>=2.7.0
22
- Requires-Dist: redis>=5.0.0
23
- Requires-Dist: tenacity>=8.2.0
24
- Provides-Extra: dev
25
- Requires-Dist: deepdiff>=6.0.0; extra == 'dev'
26
- Requires-Dist: mypy>=1.10.0; extra == 'dev'
27
- Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
28
- Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
29
- Requires-Dist: pytest>=8.0.0; extra == 'dev'
30
- Requires-Dist: respx>=0.21.0; extra == 'dev'
31
- Requires-Dist: rich>=13.7.0; extra == 'dev'
32
- Requires-Dist: ruff>=0.4.0; extra == 'dev'
33
- Requires-Dist: typer>=0.12.0; extra == 'dev'
34
- Requires-Dist: types-redis; extra == 'dev'
35
- Requires-Dist: types-requests; extra == 'dev'
36
- Description-Content-Type: text/markdown
37
-
38
- # RiotSkillIssue
39
-
40
- <div align="center">
41
-
42
- [![PyPI version](https://badge.fury.io/py/riotskillissue.svg)](https://badge.fury.io/py/riotskillissue)
43
- [![Python Versions](https://img.shields.io/pypi/pyversions/riotskillissue.svg)](https://pypi.org/project/riotskillissue/)
44
- [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
45
- [![Tests](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml/badge.svg)](https://github.com/Demoen/riotskillissue/actions/workflows/test.yml)
46
-
47
- **The production-ready, auto-updating, and fully typed Python wrapper for the Riot Games API.**
48
-
49
- [Features](#-features) • [Installation](#-installation) • [Quickstart](#-quickstart) • [Documentation](#-documentation) • [Contributing](docs/CONTRIBUTING.md) • [Changelog](CHANGELOG.md)
50
-
51
- </div>
52
-
53
- ---
54
-
55
- ## 🚀 Features
56
-
57
- - **🛡️ Type-Safe**: 100% Pydantic models for all requests and responses. No more dictionary guessing.
58
- - **🔄 Auto-Updated**: Generated daily from the [Official OpenAPI Spec](https://github.com/MingweiSamuel/riotapi-schema) with other fallbacks. Supports LoL, TFT, LoR, and VALORANT.
59
- - **⚡ Resilient by Design**: Built-in exponential backoff, circuit breakers, and correct `Retry-After` handling.
60
- - **🌍 Distributed**: Pluggable **Redis** support for shared Rate Limiting and Caching across multiple processes.
61
- - **🛠️ Developer Friendly**: Includes a powerful CLI, smart pagination helpers, and RSO (OAuth2) support.
62
-
63
- ## 📦 Installation
64
-
65
- Requires **Python 3.8+**.
66
-
67
- ```bash
68
- pip install riotskillissue
69
- ```
70
-
71
- *Or install with extra dev dependencies:*
72
- ```bash
73
- pip install "riotskillissue[dev]"
74
- ```
75
-
76
- ## ⚡ Quickstart
77
-
78
- ```python
79
- import asyncio
80
- from riotskillissue import RiotClient, Region
81
-
82
- async def main():
83
- # 1. Initialize Client (Auto-loads RIOT_API_KEY from env)
84
- async with RiotClient() as client:
85
-
86
- # 2. Type-Safe API Calls
87
- summoner = await client.summoner.get_by_puuid(
88
- region=Region.NA1,
89
- encryptedPUUID="<YOUR_PUUID>"
90
- )
91
- print(f"Summoner Level: {summoner.summonerLevel}")
92
-
93
- # 3. Smart Pagination (Async Iterator)
94
- from riotskillissue import paginate
95
- async for match_id in paginate(client.match.get_ids_by_puuid, puuid=summoner.puuid, count=20):
96
- print(f"Match: {match_id}")
97
-
98
- if __name__ == "__main__":
99
- asyncio.run(main())
100
- ```
101
-
102
- ## 🛠 Configuration
103
-
104
- Define your configuration using `RiotClientConfig` or environment variables.
105
-
106
- | Parameter | Environment Variable | Default | Description |
107
- | :--- | :--- | :--- | :--- |
108
- | **API Key** | `RIOT_API_KEY` | `None` | Your Riot Games API Key. |
109
- | **Redis URL** | - | `None` | `redis://host:port` for distributed limits. |
110
- | **Max Retries** | - | `3` | Retries for 5xx/Network errors. |
111
- | **Timeout** | - | `5s`/`10s` | Connect/Read timeouts. |
112
-
113
- ```python
114
- config = RiotClientConfig(
115
- api_key="RGAPI-...",
116
- redis_url="redis://localhost:6379/0", # Enables distributed rate limiting
117
- max_retries=5
118
- )
119
- async with RiotClient(config=config) as client:
120
- ...
121
- ```
122
-
123
- ## 🧠 Advanced Usage
124
-
125
- ### Caching
126
- Reduce your API calls with built-in caching.
127
-
128
- ```python
129
- from riotskillissue.core.cache import RedisCache
130
-
131
- cache = RedisCache("redis://localhost:6379/1")
132
- async with RiotClient(cache=cache) as client:
133
- # Requests are now cached!
134
- ...
135
- ```
136
-
137
- ### Data Dragon (Static Data)
138
- Fetch champions, items, and versions without hassle.
139
-
140
- ```python
141
- # Automatically picks the latest version and caches the result
142
- annie = await client.static.get_champion(1)
143
- print(annie["name"]) # "Annie"
144
- ```
145
-
146
- ### CLI Tool
147
- Debug your API keys or look up players instantly from the terminal.
148
-
149
- ```bash
150
- $ riotskillissue-cli summoner "Faker#SKT" --region kr
151
- {
152
- "id": "...",
153
- "accountId": "...",
154
- "puuid": "...",
155
- "name": "Faker",
156
- "profileIconId": 6,
157
- "revisionDate": 1703894832000,
158
- "summonerLevel": 678
159
- }
160
- ```
161
-
162
- ## ⚖️ Legal
163
-
164
- `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.
165
-
166
- ## 📝 License
167
-
168
- This project is licensed under the **GNU General Public License v3.0**. See the [LICENSE](LICENSE) file for details.