Unoffical osu! apiv2 python wrapper
Project description
circleapi
Yet another python wrapper for osu! api
Take a look at the "examples" folder for typical use cases.
Disclaimer
circleapi was made with my needs in mind (token management, massive concurrency, easy logging, async support), unless you know what you're doing I would highly recommend using another wrapper (aiosu, ossapi)
Main features
- Built with high concurrency in mind (thread safe, coroutine safe)
- Optional async support
- Reusable Oauth2 token (api v2)
- Automatic Oauth2 token refresh (api v2)
- Built-in rate limiting
- Built-in thread support
- Strict response validation (msgspec)
Installation
$ pip install circleapi
Development setup
$ git clone https://github.com/miinorii/circleapi.git
$ cd circleapi
$ python -m venv venv
$ venv/bin/activate # linux
$ venv/Scripts/activate.bat # windows
$ pip install -r requirements.txt
$ pip install -e .
Supported endpoints
- osu api v2
- beatmap_lookup
- get_user_beatmap_score
- get_user_beatmap_scores
- get_beatmap_scores
- get_beatmaps
- get_beatmap
- get_beatmap_attributes
- get_score
- get_own_data
- osu.lea.moe
- get_ranked_ids
- get_loved_ids
- get_ranked_and_loved_ids
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
circleapi-2024.1.6.1.tar.gz
(14.4 kB
view details)
Built Distribution
File details
Details for the file circleapi-2024.1.6.1.tar.gz
.
File metadata
- Download URL: circleapi-2024.1.6.1.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27bf496bc8cb4e086f0bc8db96eef71bf58b044f1b6b9cfb5b1382634574e226 |
|
MD5 | 17b2192a61558ef354f858583bf7f491 |
|
BLAKE2b-256 | a3d200983d4fb140458461ae5678d086ab237a120beab556aef77680dff31b78 |
File details
Details for the file circleapi-2024.1.6.1-py3-none-any.whl
.
File metadata
- Download URL: circleapi-2024.1.6.1-py3-none-any.whl
- Upload date:
- Size: 17.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ca12c767f75ab483a0686cc1fc859adfc1bf26bb79f7637d1b8904a7d3b5a95 |
|
MD5 | e129233718c852f6f4e710ac0d39463f |
|
BLAKE2b-256 | a3e6441fb960d131c0c76c6608d62a98c483c618036f92f2e0fba33d227de2fc |