https://github.com/waydeb/oppy

The wrapper you need for the osu!api v2
https://github.com/waydeb/oppy

osu osu-api osu-libraries python3

Last synced: 6 days ago
JSON representation

The wrapper you need for the osu!api v2

• Host: GitHub
• URL: https://github.com/waydeb/oppy
• Owner: waydeb
• Created: 2021-08-20T09:33:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-21T09:21:14.000Z (about 3 years ago)
• Last Synced: 2024-10-29T02:18:57.609Z (about 2 months ago)
• Topics: osu, osu-api, osu-libraries, python3
• Language: Python
• Homepage:
• Size: 35.2 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# oppy (op.py)

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

Version 1.0.0

![version](https://img.shields.io/pypi/v/op.py?style=for-the-badge)

![downloads](https://img.shields.io/pypi/dm/op.py?style=for-the-badge)

![status](https://img.shields.io/pypi/status/op.py?style=for-the-badge)

## Installation

To install please use pip to install oppy

```bash

pip install op.py

```

To install the dev version

```bash

git clone https://github.com/waydealphax/oppy

cd oppy

pip install -U .

``` 

## Examples

### Usage - User Data

```python

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

```python

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

```python

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