Skip to main content

osu.py

Discord server invite PyPI version info Download metric Documentation

Easy-to-use API wrapper for osu!api v2 written in Python. Has a high-level interface while still allowing ways to do more complex things.

Major features/capabilities

  • Python 3.8+

  • Client class that supports all endpoints

  • AsynchronousClient for async requests

  • Supports Authorization Code Grant, Client Credentials Grant, and all scopes (except lazer)

  • Builtin rate limit handling and ability to tweak it

  • Storage-efficient objects

  • Refresh and access tokens are automatically managed

  • Quality of life functions, enums, and designs

  • Extensive documentation

Installation

# Installs the latest version out on pypi

# Linux/macOS
python3 -m pip install -U osu.py

# Windows
py -3 -m pip install -U osu.py

# Installing straight from github (downloads latest code, which is not guaranteed to be stable)
py -m pip install git+https://github.com/Sheepposu/osu.py.git

# Install with asynchronous client
py -m pip install -U osu.py[async]
# Install with all features
py -m pip install -U osu.py[async,replay,notifications]

# Install from github with features
git clone https://github.com/sheppsu/osu.py
cd osu.py
py -m pip install -U .[async,replay,notifications]

Example

from osu import Client, GameModeStr

client = Client.from_credentials(0, "*****", None)
user = client.get_user(14895608, GameModeStr.STANDARD)
print(user)

Metadata

Release files for osu.py 4.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for osu.py 4.3.1
File Size Uploaded Provenance Actions
osu_py-4.3.1.tar.gz 91.4 kB Without provenance Details for osu_py-4.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for osu.py 4.3.1
File Interpreter ABI Platform Actions
osu_py-4.3.1-py3-none-any.whl Python 3 none any Details for osu_py-4.3.1-py3-none-any.whl

Total release size: 194.9 kB

Release files / osu_py-4.3.1.tar.gz

Download URL osu_py-4.3.1.tar.gz
Size 91.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8ff3880470ff7e4c6030d7ddc04461594f9d5fde3ad564f1033a8b26fe317ab4
BLAKE2b-256 checksum
How to use checksums
474756e945158a41adbb8149d1f941585fc79e3e6418eee186890e5c14308cf5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / osu_py-4.3.1-py3-none-any.whl

Download URL osu_py-4.3.1-py3-none-any.whl
Size 103.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a458919649ea0c17c5079b6cf7754d49c99df6ef296a6e2b607b503027e888f5
BLAKE2b-256 checksum
How to use checksums
8077b1db148e20d55d8edfd45c1bd72b8bf5a1ccf71e860b5020ea6c38d4f357
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Security for osu.py 4.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.3.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page