Skip to main content

API Wrapper for osu!api v2 written in Python.

Project description

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)

Project details


Release history Release notifications | RSS feed

This version

4.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

osu_py-4.2.0.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

osu_py-4.2.0-py3-none-any.whl (102.9 kB view details)

Uploaded Python 3

File details

Details for the file osu_py-4.2.0.tar.gz.

File metadata

  • Download URL: osu_py-4.2.0.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for osu_py-4.2.0.tar.gz
Algorithm Hash digest
SHA256 a40999a6789920ddeac6ad045e961ecd595be11f5bd87d419cb39ad48ec46f58
MD5 b31f64c6176f90c57341dd62b5924cec
BLAKE2b-256 8ee59da67f50467678fdb6ef572863be59d196b83b10351a022dc8b97f24c1e0

See more details on using hashes here.

File details

Details for the file osu_py-4.2.0-py3-none-any.whl.

File metadata

  • Download URL: osu_py-4.2.0-py3-none-any.whl
  • Upload date:
  • Size: 102.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for osu_py-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7639d60d73eb09a145faf823ab40546aca18fa1a366dc58f4c7b1a0bbd456a65
MD5 e2c19abfecf90084475101b53df31842
BLAKE2b-256 7b7f0aa9c278f7c68513f01a4f0314ef73e2293bf19f7cd5815048aa051c339a

See more details on using hashes here.

Supported by

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