Skip to main content

A synchronous, fully-typed Python library for the Clash Royale API

Project description

Clash Royale Python

CI Status Documentation Test coverage percentage

uv Ruff ty pre-commit

PyPi Status pyversions license


Documentation: https://guiepi.github.io/clash-royale-python/

Source Code: https://github.com/guiepi/clash-royale-python


A friendly, synchronous, fully-typed Python wrapper around the Clash Royale API.

Installation

The package is published on PyPI and can be installed by running:

pip install clash-royale-python

Basic Use

Easily query the Clash Royale API from your Python code. The data returned by the API is mapped to fully-typed Python models:

import clash_royale

client = clash_royale.Client(api_key="your-api-key")

# Get a player by tag
player = client.players.get("#ABC123")
print(player.name)

# Get a clan and its members
clan = client.clans.get("#XYZ789")
for member in client.clans.get_members("#XYZ789"):
    print(member.name)

# Search for clans
results = client.clans.search(name="Royal")
for clan in results:
    print(clan.name)

Ready for more? Check out the full documentation.

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

clash_royale_python-0.1.0.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

clash_royale_python-0.1.0-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file clash_royale_python-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for clash_royale_python-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1a22b0c7aa7e1509899233ae0c6b4494515c31a7b2d97002ebbee4ce740e0a8a
MD5 b7861efb2561ae9be0ccf78274d4bf58
BLAKE2b-256 40babab4ca4c05171a5e41bc8e2b83b4e90c74bd11fe93556b3f4960e1a90ff7

See more details on using hashes here.

Provenance

The following attestation bundles were made for clash_royale_python-0.1.0.tar.gz:

Publisher: publish.yml on GuiEpi/clash-royale-python

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

File details

Details for the file clash_royale_python-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for clash_royale_python-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9eba63f348e581b06d9b9dabbc7be849078a381b6e786c9b6ad1b912e0a5a6f6
MD5 4325e194cf24a165229ad4d693f38f67
BLAKE2b-256 71eb5f4123a54943877b7a4caf2fc82c66316f9ac8a62bee9b4a8dd18cb9f2b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for clash_royale_python-0.1.0-py3-none-any.whl:

Publisher: publish.yml on GuiEpi/clash-royale-python

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