Skip to main content

A Riot API wrapper specifically for League of Legends.

Project description

pyke

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

Installation

Install the latest version directly from PyPI:

pip install pyke-lol

Note: You need Python 3.13+ to use pyke.

Features

  • Provides a simple, pythonic interface to interact with the Riot API.
  • 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

I am currently working on adding documentation

Example Usage

from pyke import Pyke

# We always initialize the API like this
# Check examples/example.py for loading an api key from a .env file
api = Pyke("API_KEY")

# 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
# We can get 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.RateLimitExceeded as e:
    print(e)  # Output: Rate limit exceeded (Error Code: 429)
    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}")

enjoy :)

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-0.2.0.tar.gz (24.4 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-0.2.0-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyke_lol-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cde25763e3397ae8b9e319fc00949d28cbf91999213c6867e7c7d3b6b2dd9e83
MD5 5554377a1a262d80f63debf3b64a8f50
BLAKE2b-256 2861fed2e830bd6aaa4f16d5e7c779982214cca6b155430763099c70ce20f5be

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyke_lol-0.2.0.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-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyke_lol-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 38.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-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e79322c6505c2d3d9b385229aa224ea4df8154522eda897ee68fa3615966e298
MD5 07a0cdd2aa1bf004eba13d78e496e878
BLAKE2b-256 265baee269daef29ecc6c1c3040c19667495ebd415261ccfb67dcd2a2faff751

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyke_lol-0.2.0-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