Metadata-Version: 2.1
Name: ossapi
Version: 1.2.0
Summary: A thin python wrapper around the osu! api, delegating errorhandling and rate limiting (among other things) to the user.
Home-page: https://github.com/circleguard/osu-api
Author: Liam DeVoe
Author-email: orionldevoe@gmail.com
License: MIT
Download-URL: https://github.com/circleguard/osu-api/tarball/1.2.0
Keywords: osu!, wrapper, api, python
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# osuAPI

OsuAPI is a minimal python wrapper for the osu api. This wrapper was created for, and is used in, the [circleguard](https://github.com/circleguard/circleguard) project. Passed keys (endpoint parameter key/value pairs, not the api key) are checked to make sure the api will accept them, and that all required keys are present. No attempt is made to check http status codes or retry requests that fail.

### Usage

To install:
```bash
$ pip install git+https://github.com/circleguard/osu-api
```

To use:
```python
from osuAPI import OsuAPI

api = OsuAPI("API_KEY")
api.get_replay({"m": "0", "b": "1776628", "u": "3256299"})
# either strings or ints will work. Returns something like `{"content":"XQAAIA....3fISw=","encoding":"base64"}`
```


