Skip to main content

A Riot API wrapper specifically for League of Legends.

Project description

pyke

PyPI - Version Documentation PyPI - Downloads Coverage License: MIT

pyke is an opinionated, simple-by-design Riot API wrapper with smart rate limiting specifically for League of Legends.


Installation

Install the latest version directly from PyPI:

pip install pyke-lol

Quickstart

from pyke import Continent, Pyke, exceptions

# We always initialize the API like this
# We can explicitly disable url logging, by default pyke will print the url of every call
api = Pyke("API_KEY", print_url=False)

# Every pyke method follows the same convention as the Riot API
# For example account/v1/accounts/by-riot-id/{gameName}/{tagLine} becomes the following
account = api.account.by_riot_id(Continent.EUROPE, "saves", "000")

# Every response is a pydantic model whose members can be accessed with dot notation
print(f"Riot ID: {account.game_name}#{account.tag_line}")
print(f"PUUID: {account.puuid}")

# We get access to all the methods that come with a pydantic model
# For example a json string
print(account.model_dump_json())
# Or a python dictionary
print(account.model_dump())

# pyke throws custom exceptions, again following the same conventions as the Riot API
# For example a request that responds with error code 429
# Will throw pyke.exceptions.RateLimitExceeded
try:
    region = api.account.region_by_puuid(Continent.EUROPE, account.puuid)
except exceptions.DataNotFound as e:
    print(e)  # Output: Data not found (Error Code: 404)
    quit()

# Members can be accessed with dot notation just like before
print(f"PUUID: {region.puuid}")
print(f"Game: {region.game}")
print(f"Region: {region.region}")

Note: You need Python 3.9+ to use pyke.


Features

  • Provides a simple, pythonic interface to interact with the Riot API.
  • Smart rate limiting, no wasted calls and no hitting the rate limit (configurable).
  • Optimal api key usage.
  • Follows Riot API endpoints and conventions closely.
  • Returns Pydantic models for easy access to API data.
  • Custom exceptions for error handling, e.g., rate limits.

Documentation & Examples


Contact me

If you run into issues, or just have a question/need help, you can hit me up on discord. my username is .irm

enjoy :)

Pyke Logo

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyke_lol-1.4.1.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyke_lol-1.4.1-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

Details for the file pyke_lol-1.4.1.tar.gz.

File metadata

  • Download URL: pyke_lol-1.4.1.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyke_lol-1.4.1.tar.gz
Algorithm Hash digest
SHA256 7ec9c04576329012b3588a3dcbc8aa5beff445dfb77558a1c74526fcfba67283
MD5 b68cbf89a3a43de2c79425a6eb10ef0e
BLAKE2b-256 6883678a895ad7093d5f519565abb5191c4a9c58e95eb203fdff5f32eca6d127

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyke_lol-1.4.1.tar.gz:

Publisher: python-publish.yml on diodemusic/pyke

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyke_lol-1.4.1-py3-none-any.whl.

File metadata

  • Download URL: pyke_lol-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pyke_lol-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c5c66d83db90706c6ecc831648a8541b7ca97323ce8094e284b6f7db5391b6c3
MD5 f2c44e16a2a6ce4a87c4a943d23da534
BLAKE2b-256 a3f902849bd9272674607f1f9575ad8e01a749e216ad25467829194040a810cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyke_lol-1.4.1-py3-none-any.whl:

Publisher: python-publish.yml on diodemusic/pyke

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page