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 details)

Uploaded Source

File details

Details for the file losuapi-0.0.1.tar.gz.

File metadata

  • Download URL: losuapi-0.0.1.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for losuapi-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ec480779027087721b308b1cca1f88a99de373e84afcc08a511dac44bbb311a6
MD5 5ea6686a5efd7aee4a00ea327d680547
BLAKE2b-256 f5c485fcebfda495db3af5447721865d8823e7be4a369a7ed65bffaba3b686c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page