aiordr
Simple and fast asynchronous library for the o!rdr API.
Features
Support for modern async syntax (async with)
Event decorators
Rate limit handling
Easy to use
Installing
Python 3.9 or higher is required
To install the library, simply run the following commands
# Linux/macOS
python3 -m pip install -U aiordr
# Windows
py -3 -m pip install -U aiordr
To install the development version, do the following:
$ git clone https://github.com/NiceAesth/aiordr
$ cd aiordr
$ python3 -m pip install -U .
API Example
import aiordr
import asyncio
async def main():
client = aiordr.ordrClient(verification_key="verylongstring")
await client.create_render(
"username",
"YUGEN",
replay_url="https://url.to.replay",
)
@client.on_render_added
async def on_render_added(event: aiordr.models.RenderAddEvent) -> None:
print(event)
@client.on_render_progress
async def on_render_progress(event: aiordr.models.RenderProgressEvent) -> None:
print(event)
@client.on_render_fail
async def on_render_fail(event: aiordr.models.RenderFailEvent) -> None:
print(event)
@client.on_render_finish
async def on_render_finish(event: aiordr.models.RenderFinishEvent) -> None:
print(event)
if __name__ == "__main__":
asyncio.run(main())
Contributing
Please read the CONTRIBUTING.rst to learn how to contribute to aiordr!
Acknowledgments
discord.py for README formatting
aiosu sister library for the osu! API
Metadata
Release files for aiordr 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aiordr-0.3.0.tar.gz | 23.2 kB | Without provenance | Details for aiordr-0.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aiordr-0.3.0-py3-none-any.whl | Python 3 | none | any | Details for aiordr-0.3.0-py3-none-any.whl |
Total release size: 48.2 kB
Release files / aiordr-0.3.0.tar.gz
| Download URL | aiordr-0.3.0.tar.gz |
|---|---|
| Size | 23.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d0f6af31f24e9eb66f1fb7f47c6e46325bb7667a1f3f0fd4c6a48f8acb70a51f
|
|
BLAKE2b-256 checksum How to use checksums |
541d0b5edf6fd7fa8ff66d4c2924c5f120a535c94df361a2f17d426a07bf61a6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.9.18 Linux/6.5.0-1016-azure
|
Release files / aiordr-0.3.0-py3-none-any.whl
| Download URL | aiordr-0.3.0-py3-none-any.whl |
|---|---|
| Size | 25.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
833fd25bc2d437601eb9680b09d37030014497afc54b046047b2ae9141913e42
|
|
BLAKE2b-256 checksum How to use checksums |
dc12699a36ccf2f4ea7adb980d8fdf378efa2dfe32c8cd4119fde45dd0195e34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.2 CPython/3.9.18 Linux/6.5.0-1016-azure
|
Security for aiordr 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.