Metadata-Version: 2.4
Name: supertuxkart.py
Version: 0.1.5
Summary: A library that allows interacting with the SuperTuxKart API
Author-email: Vyxie <kitakita@disroot.org>
License-Expression: MIT
Project-URL: Homepage, https://codeberg.org/linaSTK/stk.py
Project-URL: Issues, https://codeberg.org/linaSTK/stk.py/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: aiohttp
Dynamic: license-file

# SuperTuxKart API Wrapper for Python
![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fcodeberg.org%2FlinaSTK%2Fstk.py%2Fraw%2Fbranch%2Fmain%2Fpyproject.toml)
![PyPI - License](https://img.shields.io/pypi/l/supertuxkart.py)
![Gitea Stars](https://img.shields.io/gitea/stars/linaSTK/stk.py?gitea_url=https%3A%2F%2Fcodeberg.org&style=flat)
![Gitea Last Commit](https://img.shields.io/gitea/last-commit/linaSTK/stk.py?gitea_url=https%3A%2F%2Fcodeberg.org)

A library that allows for interacting with teh SuperTuxKart API.

# Install
You can install supertuxkart.py using the following command:
```
pip install supertuxkart.py
```
... or if you want to use the git/development version:
```
pip install git+https://codeberg.org/linaSTK/stk.py
```

# Example:
```py
>>> import supertuxkart
>>> client = supertuxkart.SuperTuxKartClient(userid=513714, token="<token here>")
>>> # You can also use username/password auth, though
>>> # userid/token is prioritized if both specified
>>> client = supertuxkart.SuperTuxKartClient(username="Sayori", password="password")
>>> session = client.account.saved_session()
>>> session.userid
513714
>>> session.username
'Sayori'
```

# License
This project is licensed under the MIT license.
