.. image:: https://img.shields.io/pypi/v/aiowowapi.svg
:target: https://pypi.python.org/pypi/aiowowapi
:alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/aiowowapi.svg
:target: https://pypi.python.org/pypi/aiowowapi
:alt: PyPI supported Python versions
.. image:: https://github.com/Adalyia/aiowowapi/actions/workflows/tests.yml/badge.svg
:target: https://github.com/Adalyia/aiowowapi/actions/workflows/tests.yml
:alt: Test Status
.. image:: https://readthedocs.org/projects/aiowowapi/badge/?version=latest
:target: https://aiowowapi.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
aiowowapi docs
=====================================
Warning: I have personally stopped playing World of Warcraft, if you'd like to take over maintenance of the project or see any issues you can create an issue on GitHub and I promise I'll look into it ASAP.
An asynchronous client library for interacting with the World of Warcraft API endpoints using the ``async`` / ``await`` syntax.
Installing
-----------
.. code:: sh
# Linux/OSX
python3 -m pip install -U aiowowapi
# Windows
python -m pip install -U aiowowapi
Current Features
---------------------
* Retail Game Data API Support
* Retail Profile API Support
* Classic Game Data API Support
* Rate limiting
* Request retries
* QoL WoW-Specific functions (Money -> Gold/Silver/Copper, Armoury link parser, etc)
TODO
-----
* Add caching for certain requests (e.g. character profile)
* Greater test coverage
Requirements
-------------
* `aiohttp <https://docs.aiohttp.org/en/stable/>`_
* Python 3.8+
Example
--------
.. code-block:: python
from aiowowapi import WowApi
async def main():
async with WowApi('<ID>','<SECRET>', 'us', request_debugging=True) as Client:
print(await Client.Retail.Profile.get_character_profile_status('illidan', 'adalyia'))
Links
------
* `aiowowapi's Documentation <https://aiowowapi.readthedocs.io/en/latest/>`_
* `Blizzard's API Documentation <https://develop.battle.net/documentation>`_
* `Register a Blizzard API Client <https://develop.battle.net/access/clients>`_
* `Blizzard's API Forums <https://us.forums.blizzard.com/en/blizzard/c/api-discussion/18>`_
IMPORTANT
----------
This project is not affiliated with or endorsed by `Blizzard Entertainment <https://www.blizzard.com/>`_ & all data is retrieved from official Blizzard / World of Warcraft APIs. `Terms found here <https://www.blizzard.com/en-us/legal/a2989b50-5f16-43b1-abec-2ae17cc09dd6/blizzard-developer-api-terms-of-use>`_. Additionally this project was created primarily for use with Discord Bots & other async applications with inspiration from `this project <https://github.com/lockwooddev/python-wowapi>`_ by `lockwooddev <https://github.com/lockwooddev/>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/Adalyia/aiowowapi",
"name": "aiowowapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "wow, world of warcraft, api, wrapper, asynchronous, async, battle.net, blizzard",
"author": "Adalyia",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f0/74/0f21242eaff96b036a39977d97d58d8174f18febabb6f45087abf9bc2fb3/aiowowapi-2.1.5.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/aiowowapi.svg\r\n :target: https://pypi.python.org/pypi/aiowowapi\r\n :alt: PyPI version info\r\n.. image:: https://img.shields.io/pypi/pyversions/aiowowapi.svg\r\n :target: https://pypi.python.org/pypi/aiowowapi\r\n :alt: PyPI supported Python versions\r\n.. image:: https://github.com/Adalyia/aiowowapi/actions/workflows/tests.yml/badge.svg\r\n :target: https://github.com/Adalyia/aiowowapi/actions/workflows/tests.yml\r\n :alt: Test Status\r\n.. image:: https://readthedocs.org/projects/aiowowapi/badge/?version=latest\r\n :target: https://aiowowapi.readthedocs.io/en/latest/?badge=latest\r\n :alt: Documentation Status\r\n\r\naiowowapi docs\r\n=====================================\r\n\r\nWarning: I have personally stopped playing World of Warcraft, if you'd like to take over maintenance of the project or see any issues you can create an issue on GitHub and I promise I'll look into it ASAP.\r\n\r\nAn asynchronous client library for interacting with the World of Warcraft API endpoints using the ``async`` / ``await`` syntax.\r\n\r\n\r\nInstalling\r\n-----------\r\n.. code:: sh\r\n\r\n # Linux/OSX\r\n python3 -m pip install -U aiowowapi\r\n\r\n # Windows\r\n python -m pip install -U aiowowapi\r\n\r\n\r\nCurrent Features\r\n---------------------\r\n* Retail Game Data API Support\r\n* Retail Profile API Support\r\n* Classic Game Data API Support\r\n* Rate limiting\r\n* Request retries\r\n* QoL WoW-Specific functions (Money -> Gold/Silver/Copper, Armoury link parser, etc)\r\n\r\nTODO\r\n-----\r\n* Add caching for certain requests (e.g. character profile)\r\n* Greater test coverage\r\n\r\nRequirements\r\n-------------\r\n* `aiohttp <https://docs.aiohttp.org/en/stable/>`_\r\n* Python 3.8+\r\n\r\nExample\r\n--------\r\n.. code-block:: python\r\n\r\n from aiowowapi import WowApi\r\n\r\n async def main():\r\n async with WowApi('<ID>','<SECRET>', 'us', request_debugging=True) as Client:\r\n print(await Client.Retail.Profile.get_character_profile_status('illidan', 'adalyia'))\r\n\r\n\r\nLinks\r\n------\r\n* `aiowowapi's Documentation <https://aiowowapi.readthedocs.io/en/latest/>`_\r\n* `Blizzard's API Documentation <https://develop.battle.net/documentation>`_\r\n* `Register a Blizzard API Client <https://develop.battle.net/access/clients>`_\r\n* `Blizzard's API Forums <https://us.forums.blizzard.com/en/blizzard/c/api-discussion/18>`_\r\n\r\n\r\nIMPORTANT\r\n----------\r\nThis project is not affiliated with or endorsed by `Blizzard Entertainment <https://www.blizzard.com/>`_ & all data is retrieved from official Blizzard / World of Warcraft APIs. `Terms found here <https://www.blizzard.com/en-us/legal/a2989b50-5f16-43b1-abec-2ae17cc09dd6/blizzard-developer-api-terms-of-use>`_. Additionally this project was created primarily for use with Discord Bots & other async applications with inspiration from `this project <https://github.com/lockwooddev/python-wowapi>`_ by `lockwooddev <https://github.com/lockwooddev/>`_.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An asynchronous Python wrapper for the World of Warcraft APIs.",
"version": "2.1.5",
"project_urls": {
"Homepage": "https://github.com/Adalyia/aiowowapi"
},
"split_keywords": [
"wow",
" world of warcraft",
" api",
" wrapper",
" asynchronous",
" async",
" battle.net",
" blizzard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "21db523c0727ddcc095669cf4f22e7274f256561b0363ca618b7ad706866d80c",
"md5": "5172ceb0d907fcd34e8cd2f0ea95ebaf",
"sha256": "a463b1b35ff7e9f7d050b94f721f6e5c92747b0b934b1a803be191d5f57eafcf"
},
"downloads": -1,
"filename": "aiowowapi-2.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5172ceb0d907fcd34e8cd2f0ea95ebaf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24263,
"upload_time": "2024-10-28T20:44:31",
"upload_time_iso_8601": "2024-10-28T20:44:31.275417Z",
"url": "https://files.pythonhosted.org/packages/21/db/523c0727ddcc095669cf4f22e7274f256561b0363ca618b7ad706866d80c/aiowowapi-2.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0740f21242eaff96b036a39977d97d58d8174f18febabb6f45087abf9bc2fb3",
"md5": "e7f4fc2f1f2a039629dcc0c99b671bae",
"sha256": "02efc0186bdfdd16a6d3ca5f369d63bbe0f38193b75c308989a5d0001e140d00"
},
"downloads": -1,
"filename": "aiowowapi-2.1.5.tar.gz",
"has_sig": false,
"md5_digest": "e7f4fc2f1f2a039629dcc0c99b671bae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23811,
"upload_time": "2024-10-28T20:44:32",
"upload_time_iso_8601": "2024-10-28T20:44:32.438130Z",
"url": "https://files.pythonhosted.org/packages/f0/74/0f21242eaff96b036a39977d97d58d8174f18febabb6f45087abf9bc2fb3/aiowowapi-2.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 20:44:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Adalyia",
"github_project": "aiowowapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiowowapi"
}
JSON
