Skip to main content

A Riot API wrapper specifically for League of Legends.

Project description

pyke

Upload Python Package PyPI - Version License: MIT Coverage

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

Pyke Logo

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
# We can explicitly disable url logging, by default pyke will log all url calls
api = Pyke(API_KEY, log_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.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-1.1.0.tar.gz (25.2 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.1.0-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyke_lol-1.1.0.tar.gz
  • Upload date:
  • Size: 25.2 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.1.0.tar.gz
Algorithm Hash digest
SHA256 4ba6e0704d058f6f91b3a0f2950e19544fd0998293f84d704f7896669c5abda0
MD5 15a735d21c263af7afe6dff60c7cf5a0
BLAKE2b-256 61148d45778c252842aa106ad493c444df7343e4ecc9a326cfc632b2034d2140

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pyke_lol-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 39.9 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62f36d3ed961a3ba50921339694daac1e0c84a82e637f222b028c839e1babffa
MD5 75a54b902e7ba5e689c1468feee1f8e9
BLAKE2b-256 5fe6f9cec44779d89cb1a410641f93a3c5d2c818131065f8181e038bc4eabb6d

See more details on using hashes here.

Provenance

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