aiordr
======
|Python| |pypi| |pre-commit.ci status| |rtd| |pytest| |mypy| |codacy|
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
.. code:: sh
# Linux/macOS
python3 -m pip install -U aiordr
# Windows
py -3 -m pip install -U aiordr
To install the development version, do the following:
.. code:: sh
$ git clone https://github.com/NiceAesth/aiordr
$ cd aiordr
$ python3 -m pip install -U .
API Example
-----------
.. code:: py
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 <.github/CONTRIBUTING.rst>`__ to learn how to contribute to aiordr!
Acknowledgments
---------------
- `discord.py <https://github.com/Rapptz/discord.py>`__
for README formatting
- `aiosu <https://github.com/NiceAesth/aiosu>`__
sister library for the osu! API
.. |Python| image:: https://img.shields.io/pypi/pyversions/aiordr.svg
:target: https://pypi.python.org/pypi/aiordr
:alt: Python version info
.. |pypi| image:: https://img.shields.io/pypi/v/aiordr.svg
:target: https://pypi.python.org/pypi/aiordr
:alt: PyPI version info
.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/NiceAesth/aiordr/master.svg
:target: https://results.pre-commit.ci/latest/github/NiceAesth/aiordr/master
:alt: pre-commit.ci status
.. |pytest| image:: https://github.com/NiceAesth/aiordr/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/NiceAesth/aiordr/actions/workflows/pytest.yml
:alt: pytest Status
.. |mypy| image:: https://github.com/NiceAesth/aiordr/actions/workflows/mypy.yml/badge.svg
:target: https://github.com/NiceAesth/aiordr/actions/workflows/mypy.yml
:alt: mypy Status
.. |rtd| image:: https://readthedocs.org/projects/aiordr/badge/?version=latest
:target: https://aiordr.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |codacy| image:: https://app.codacy.com/project/badge/Grade/4778d5ee1dc84469ad6a43a6f961c0eb
:target: https://www.codacy.com/gh/NiceAesth/aiordr/dashboard?utm_source=github.com&utm_medium=referral&utm_content=NiceAesth/aiordr&utm_campaign=Badge_Grade
:alt: Codacy Status
Raw data
{
"_id": null,
"home_page": "https://github.com/NiceAesth/aiordr",
"name": "aiordr",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "osu!, osu, api",
"author": "Nice Aesthetics",
"author_email": "nice@aesth.dev",
"download_url": "https://files.pythonhosted.org/packages/54/1d/0b5edf6fd7fa8ff66d4c2924c5f120a535c94df361a2f17d426a07bf61a6/aiordr-0.3.0.tar.gz",
"platform": null,
"description": "aiordr\n======\n\n|Python| |pypi| |pre-commit.ci status| |rtd| |pytest| |mypy| |codacy|\n\nSimple and fast asynchronous library for the o!rdr API.\n\n\nFeatures\n--------\n\n- Support for modern async syntax (async with)\n- Event decorators\n- Rate limit handling\n- Easy to use\n\n\nInstalling\n----------\n\n**Python 3.9 or higher is required**\n\nTo install the library, simply run the following commands\n\n.. code:: sh\n\n # Linux/macOS\n python3 -m pip install -U aiordr\n\n # Windows\n py -3 -m pip install -U aiordr\n\n\nTo install the development version, do the following:\n\n.. code:: sh\n\n $ git clone https://github.com/NiceAesth/aiordr\n $ cd aiordr\n $ python3 -m pip install -U .\n\n\nAPI Example\n-----------\n\n.. code:: py\n\n import aiordr\n import asyncio\n\n\n async def main():\n client = aiordr.ordrClient(verification_key=\"verylongstring\")\n\n await client.create_render(\n \"username\",\n \"YUGEN\",\n replay_url=\"https://url.to.replay\",\n )\n\n @client.on_render_added\n async def on_render_added(event: aiordr.models.RenderAddEvent) -> None:\n print(event)\n\n @client.on_render_progress\n async def on_render_progress(event: aiordr.models.RenderProgressEvent) -> None:\n print(event)\n\n @client.on_render_fail\n async def on_render_fail(event: aiordr.models.RenderFailEvent) -> None:\n print(event)\n\n @client.on_render_finish\n async def on_render_finish(event: aiordr.models.RenderFinishEvent) -> None:\n print(event)\n\n\n if __name__ == \"__main__\":\n asyncio.run(main())\n\n\nContributing\n------------\n\nPlease read the `CONTRIBUTING.rst <.github/CONTRIBUTING.rst>`__ to learn how to contribute to aiordr!\n\n\nAcknowledgments\n---------------\n\n- `discord.py <https://github.com/Rapptz/discord.py>`__\n for README formatting\n- `aiosu <https://github.com/NiceAesth/aiosu>`__\n sister library for the osu! API\n\n\n.. |Python| image:: https://img.shields.io/pypi/pyversions/aiordr.svg\n :target: https://pypi.python.org/pypi/aiordr\n :alt: Python version info\n.. |pypi| image:: https://img.shields.io/pypi/v/aiordr.svg\n :target: https://pypi.python.org/pypi/aiordr\n :alt: PyPI version info\n.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/NiceAesth/aiordr/master.svg\n :target: https://results.pre-commit.ci/latest/github/NiceAesth/aiordr/master\n :alt: pre-commit.ci status\n.. |pytest| image:: https://github.com/NiceAesth/aiordr/actions/workflows/pytest.yml/badge.svg\n :target: https://github.com/NiceAesth/aiordr/actions/workflows/pytest.yml\n :alt: pytest Status\n.. |mypy| image:: https://github.com/NiceAesth/aiordr/actions/workflows/mypy.yml/badge.svg\n :target: https://github.com/NiceAesth/aiordr/actions/workflows/mypy.yml\n :alt: mypy Status\n.. |rtd| image:: https://readthedocs.org/projects/aiordr/badge/?version=latest\n :target: https://aiordr.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. |codacy| image:: https://app.codacy.com/project/badge/Grade/4778d5ee1dc84469ad6a43a6f961c0eb\n :target: https://www.codacy.com/gh/NiceAesth/aiordr/dashboard?utm_source=github.com&utm_medium=referral&utm_content=NiceAesth/aiordr&utm_campaign=Badge_Grade\n :alt: Codacy Status\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Simple and fast library for interacting with the o!rdr API.",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://aiordr.readthedocs.io/",
"Homepage": "https://github.com/NiceAesth/aiordr",
"Repository": "https://github.com/NiceAesth/aiordr"
},
"split_keywords": [
"osu!",
" osu",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc12699a36ccf2f4ea7adb980d8fdf378efa2dfe32c8cd4119fde45dd0195e34",
"md5": "04ad7384f68bdbabf367da754cd4c8de",
"sha256": "833fd25bc2d437601eb9680b09d37030014497afc54b046047b2ae9141913e42"
},
"downloads": -1,
"filename": "aiordr-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04ad7384f68bdbabf367da754cd4c8de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 25009,
"upload_time": "2024-03-23T18:32:46",
"upload_time_iso_8601": "2024-03-23T18:32:46.827480Z",
"url": "https://files.pythonhosted.org/packages/dc/12/699a36ccf2f4ea7adb980d8fdf378efa2dfe32c8cd4119fde45dd0195e34/aiordr-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "541d0b5edf6fd7fa8ff66d4c2924c5f120a535c94df361a2f17d426a07bf61a6",
"md5": "63ad05c97b4fee47d2a8cc5600d42a21",
"sha256": "d0f6af31f24e9eb66f1fb7f47c6e46325bb7667a1f3f0fd4c6a48f8acb70a51f"
},
"downloads": -1,
"filename": "aiordr-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "63ad05c97b4fee47d2a8cc5600d42a21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 23162,
"upload_time": "2024-03-23T18:32:48",
"upload_time_iso_8601": "2024-03-23T18:32:48.734384Z",
"url": "https://files.pythonhosted.org/packages/54/1d/0b5edf6fd7fa8ff66d4c2924c5f120a535c94df361a2f17d426a07bf61a6/aiordr-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 18:32:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NiceAesth",
"github_project": "aiordr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiordr"
}
JSON
