Skip to main content

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


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 hashes)

Uploaded Source

Built Distribution

circleapi-2024.1.6.1-py3-none-any.whl (17.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page