Metadata-Version: 2.4
Name: mcsrranked
Version: 0.2.0
Summary: Python SDK for the MCSR Ranked API
Project-URL: Homepage, https://github.com/camodotgg/mcsrranked-python
Project-URL: Documentation, https://camodotgg.github.io/mcsrranked-python
Project-URL: Repository, https://github.com/camodotgg/mcsrranked-python
Author-email: Camo <camodotgg@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: api,mcsr,mcsr ranked,python,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27.0
Requires-Dist: pydantic>=2.0.0
Provides-Extra: dev
Requires-Dist: mypy>=1.13.0; extra == 'dev'
Requires-Dist: pre-commit>=4.0.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: respx>=0.21.0; extra == 'dev'
Requires-Dist: ruff>=0.8.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: griffe-pydantic>=1.0.0; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.27.0; extra == 'docs'
Description-Content-Type: text/markdown

# mcsrranked

[![PyPI version](https://badge.fury.io/py/mcsrranked.svg)](https://badge.fury.io/py/mcsrranked)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

mcsrranked is a Python SDK for the [MCSR Ranked API](https://mcsrranked.com/).

## Installation

```bash
# Using uv
uv add mcsrranked

# Using pip
pip install mcsrranked
```

## Examples

```python
import mcsrranked

# Get a player's profile
user = mcsrranked.users.get("Feinberg")
print(f"{user.nickname}: {user.elo_rate} elo")

# Get the leaderboard
leaderboard = mcsrranked.leaderboards.elo()
for player in leaderboard.users[:5]:
    print(f"#{player.elo_rank} {player.nickname}")
```

See more [examples](https://github.com/camodotgg/mcsrranked-python/tree/main/examples).

## Documentation

For full documentation, visit **[camodotgg.github.io/mcsrranked-python](https://camodotgg.github.io/mcsrranked-python)**.

- [Getting Started](https://camodotgg.github.io/mcsrranked-python/getting-started/quickstart/)
- [API Reference](https://camodotgg.github.io/mcsrranked-python/api/client/)
- [Examples](https://camodotgg.github.io/mcsrranked-python/examples/)

## Contributing

```bash
git clone https://github.com/camodotgg/mcsrranked-python
cd mcsrranked-python
uv sync --all-extras
uv run pre-commit install
```

Run checks:

```bash
uv run ruff check src/
uv run mypy src/
uv run pytest
```
