Skip to main content

API Wrapper for osu!api v2 written in Python.

Reason this release was yanked:

accidentally left debug code

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

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.3.0.tar.gz (91.4 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.3.0-py3-none-any.whl (103.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: osu_py-4.3.0.tar.gz
  • Upload date:
  • Size: 91.4 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.3.0.tar.gz
Algorithm Hash digest
SHA256 b5a3f45168df56a6aa5452bf2d948914332da5244f9168e996d8d00621a5cc69
MD5 73e263855854fd17629969a3d7211875
BLAKE2b-256 b174127db7437571fe6c0d61189ef43f6a5a7192912b792a37bc75c9a5727c82

See more details on using hashes here.

File details

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

File metadata

  • Download URL: osu_py-4.3.0-py3-none-any.whl
  • Upload date:
  • Size: 103.6 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46fe6c1834491a9651f18d7acf6a3a42afadd5be98b4e8b42a2ba838a9d4a512
MD5 b53ff3239d8e420acc032dafe11b7299
BLAKE2b-256 d48c9a7ecdbe0322ca11018abe8cf1ae40198d408dde7ca2945f150086c25fcf

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