Skip to content

A simple python implementation for the Osu! api

License

Notifications You must be signed in to change notification settings

Renondedju/Osu.py

Repository files navigation

Osu.py library

A simple python implementation for the Osu! api.

This library is developed for Uso! bot, a discord recommendation bot for osu beatmaps

Requirements

  • Python 3.6+ (anterior versions might be supported but haven't been tested.)
  • The aiohttp library : Install instructions
  • An internet connexion

Installation

Open a terminal and write

pip install git+https://github.com/Renondedju/Osu.py

Or from the source

$ git clone https://github.com/Renondedju/Osu.py
$ cd Osu.py
$ pip install .

Example

import asyncio
from pyosu import OsuApi

async def main():
    
    api = OsuApi('Your api key here')

    bests = await api.get_user_bests('Renondedju')
    for best in bests:
        print(best.__dict__)

if __name__ == '__main__':
    asyncio.run(main())

Documentations

Link to the docs

Modifications

To get the current version of the library simply write and execute :

import pyosu #Make sure your import path is the right one
print(pyosu.__version__)

Link to the chagelogs

Thanks

Thanks to @ppy for the osu api

License

Osu.py is released under the MIT License. Check the license for more details.