Metadata-Version: 2.1
Name: osu.py
Version: 0.1.13
Summary: Easy to use API wrapper for osu!api written in Python.
Home-page: https://github.com/Sheepposu/osu.py
Author: Sheepposu
Author-email: osuapi.py@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Sheepposu/osu.py/issues
Project-URL: osu.py Documentation, https://osupy.readthedocs.io/en/latest/
Project-URL: osu!api v2 Documentation, https://osu.ppy.sh/docs/index.html
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

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/>`_


