Skip to main content

Python wrapper for the Osu apiv2.

Project description

Losuapi

Python wrapper for the Osu apiV2

Important

Extremely work in progress


Setup

  • Register an Oauth application on the osu account settings page.
    • Do not set an Application callback URL, the current version of this package does not need one.
  • Set environment variables however you like.

setting environment variables example

export CLIENT_ID = registered_client_id
export CLIENT_SECRET = registered_client_secret

creating client_id and client_secret variables example

import os

CLIENT_ID = os.getenv("CLIENT_ID")
CLIENT_SECRET = os.getenv("CLIENT_SECRET")

Basic usage

example:

import losuapi

# instantiate OsuApi object
api = losuapi.OsuApi(client_id=CLIENT_ID, cleint_secret=CLIENT_SECRET)

# lookup_beatmap method returns a losu.Beatmap object
beatmap: losuapi.Beatmap = api.lookup_beatmap(beatmap_id=1920615)

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

losuapi-0.0.1.tar.gz (15.9 kB view hashes)

Uploaded Source

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