Metadata-Version: 2.4
Name: clash-royale-python
Version: 0.2.2
Summary: A fully-typed Python library for the Clash Royale API
Project-URL: Homepage, https://github.com/guiepi/clash-royale-python
Project-URL: Documentation, https://guiepi.github.io/clash-royale-python/
Project-URL: Repository, https://github.com/guiepi/clash-royale-python
Project-URL: Issues, https://github.com/guiepi/clash-royale-python/issues
Author: Guillaume Coussot
License-Expression: MIT
License-File: LICENSE.md
Keywords: api,async,clash-royale,gaming,supercell,typed,wrapper
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: httpx>=0.28.1
Requires-Dist: pydantic>=2.12.5
Description-Content-Type: text/markdown

Clash Royale Python 👑

        pyversions
        license

    A friendly, fully-typed Python wrapper around the Clash Royale API (https://developer.clashroyale.com).

    Source code (https://github.com/guiepi/clash-royale-python)
     · 
    Documentation (https://guiepi.github.io/clash-royale-python/)

    Cooked by Guillaume Coussot (https://github.com/GuiEpi/) 👨‍🍳

## Installation

The package is published on [PyPI](https://pypi.org/project/clash-royale-python/) and can be installed by running:

```shell
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:

```python
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](https://guiepi.github.io/clash-royale-python/).
