Metadata-Version: 2.4
Name: mctiers
Version: 0.1.0
Summary: An async Python wrapper for the MCTiers API
Author: MCTiers.py contributors
License: MIT
License-File: LICENSE
Keywords: api,async,mctiers,minecraft
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: aiohttp>=3.8
Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
Description-Content-Type: text/markdown

# mctiers

An async Python wrapper for the [MCTiers](https://mctiers.com/) API.

The library is built with an `aiohttp` HTTP layer and a higher-level client that
returns Python model objects.

## Installing

```bash
python -m pip install mctiers
```

To install the local project while developing:

```bash
python -m pip install -e .
```

## Quick Example

```python
import asyncio

import mctiers


async def main() -> None:
    async with mctiers.Client() as client:
        profile = await client.fetch_player_profile_by_name(
            "ItzRealMe",
            badges=True,
            tests=True
        )

        print(profile.name)
        print(profile.points)


asyncio.run(main())
```

## Proxy Support

```python
client = mctiers.Client(
    proxy_url="http://127.0.0.1:8080"
)
```

`proxy_auth` accepts `aiohttp.BasicAuth`.

## Requirements

- Python 3.9+
- aiohttp

## License

MIT
