Skip to main content

Easy to use API wrapper for osu!api written in Python.

Project description

osu.py

.. image:: https://discordapp.com/api/guilds/836755328493420614/widget.png?style=shield :target: https://discord.gg/Z2J6SSRPcE :alt: Discord server invite .. image:: https://img.shields.io/pypi/v/osu.py.svg :target: https://pypi.python.org/pypi/osu.py :alt: PyPI version info

Easy to use API wrapper for osu!api written in Python. This uses osu!api v2, which is still under development. So some code that was originally working may break overnight. However, I'll do my best to fix any issues I find as quick as possible. You can report issues here <https://github.com/Sheepposu/osu.py/issues>_ or make a pull requests <https://github.com/Sheepposu/osu.py/pulls>_ if you'd like to contribute.

Installation

.. code:: sh

# 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

Example

.. code:: py

from osu import Client, AuthHandler


client_id = 0
client_secret = "***"
redirect_uri = "http://127.0.0.1:8080"

auth = AuthHandler(client_id, client_secret, redirect_uri)
auth.get_auth_token()

client = Client(auth)

user_id = 14895608
mode = 'osu'
user = client.get_user(user_id, mode)
print(user.username)

To learn more you can go to the documentation here <https://osupy.readthedocs.io/en/latest/>_

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

osu.py-0.1.13.tar.gz (26.4 kB view hashes)

Uploaded Source

Built Distribution

osu.py-0.1.13-py3-none-any.whl (27.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