README.md

oppy (op.py)

oppy is the wrapper for use on the osu! v2 API. Version 1.0.0

Installation

To install please use pip to install oppy

pip install op.py

To install the dev version

git clone https://github.com/waydealphax/oppy
cd oppy
pip install -U .

Examples

Usage - User Data

import oppy
import asyncio
client = oppy.Client()
user = client.user_data
async def main():
    data = await user.user(user="peppy", token="a long string") #makes the api request using oppy.Client.user_data.user()
    print(
    data.pp, # User PP
    data.id, # User ID
    data.username, # Username
    data.global_rank, # User Global Rank
    )
asyncio.get_event_loop().run_until_complete(main())

Usage - Beatmap Data | Lookup

import oppy
import asyncio
client = oppy.Client()
beatmap = client.beatmap_data
async def main():
    data = await beatmap.lookup(beatmap="big black", token="a long string") #makes the api request using oppy.Client.beatmap_data.lookup()
    print(
    data.id, # Map ID
    data.artist, # Map song artist
    data.mapper, # Map creator
    )
asyncio.get_event_loop().run_until_complete(main())

Usage - Token

import oppy
import asyncio
client = oppy.Client()
tk = client.gen_token
async def main():
    tkn = await tk.gen(client_secret="string", client_id=0) # makes request using oppy.Client.gen_token.gen()
    print(tkn) # Token - I would save this in a file every time you get a new token.
asyncio.get_event_loop().run_until_complete(main())

More examples in exmaples/

Support

Feel free to email me at [email protected] or contact me on discord support server https://discord.gg/DAPgevH9EX