aiosu
Simple and fast asynchronous osu! API v1 and v2 library with various utilities.
Features
Support for modern async syntax (async with)
Support for API v1 and API v2
Rate limit handling
Utilities for osu! related calculations
Easy to use
Installing
Python 3.10 or higher is required
To install the library, simply run the following commands
# Linux/macOS
python3 -m pip install -U aiosu
# Windows
py -3 -m pip install -U aiosu
To install the development version, do the following:
$ git clone https://github.com/NiceAesth/aiosu
$ cd aiosu
$ python3 -m pip install -U .
API v1 Example
import aiosu
import asyncio
async def main():
# async with syntax
async with aiosu.v1.Client("osu api token") as client:
user = await client.get_user(7782553)
# regular syntax
client = aiosu.v1.Client("osu api token")
user = await client.get_user(7782553)
await client.aclose()
if __name__ == "__main__":
asyncio.run(main())
API v2 Example
import aiosu
import asyncio
import datetime
async def main():
token = aiosu.models.OAuthToken.model_validate(json_token_from_api)
# or
token = aiosu.models.OAuthToken(
access_token="access token",
refresh_token="refresh token",
expires_on=datetime.datetime.utcnow()
+ datetime.timedelta(days=1), # can also be string
)
# async with syntax
async with aiosu.v2.Client(
client_secret="secret", client_id=1000, token=token
) as client:
user = await client.get_me()
# regular syntax
client = aiosu.v2.Client(client_secret="secret", client_id=1000, token=token)
user = await client.get_me()
await client.aclose()
if __name__ == "__main__":
asyncio.run(main())
You can find more examples in the examples directory.
Contributing
Please read the CONTRIBUTING.rst to learn how to contribute to aiosu!
Acknowledgments
discord.py for README formatting
osu!Akatsuki for performance and accuracy utils
Release files for aiosu 2.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aiosu-2.5.0.tar.gz | 63.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aiosu-2.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 145.0 kB
Release files / aiosu-2.5.0.tar.gz
| Download URL | aiosu-2.5.0.tar.gz |
|---|---|
| Size | 63.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a6db0ecb3c5395a9ffdefc30bb6fa3145af391de918f8890a5e56d8515277e7
|
|
BLAKE2b-256 checksum How to use checksums |
13b59ebf5e460e7bd272f840bf89d6387638c3d551baabb7dcae10963f804db0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.10.20 Linux/6.17.0-1018-azure
|
Release files / aiosu-2.5.0-py3-none-any.whl
| Download URL | aiosu-2.5.0-py3-none-any.whl |
|---|---|
| Size | 81.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
67e88d25e5065fce3981bb12e4923ca4f96c062de6d36e617a3574a400804db2
|
|
BLAKE2b-256 checksum How to use checksums |
77ac86d98c9da839963637a169c95a99fcd77b59a96eb65ff0a62ad3a624e239
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.1 CPython/3.10.20 Linux/6.17.0-1018-azure
|