aenox

Name	aenox JSON
Version	0.1.6 JSON
	download
home_page	None
Summary	Official wrapper for the AenoX API
upload_time	2025-01-20 02:33:40
maintainer	None
docs_url	None
author	aenoxic
requires_python	>=3.10
license	MIT
keywords	aenox discord bot api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # AenoX API
[![](https://img.shields.io/pypi/v/aenox.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/aenox/)
[![](https://img.shields.io/pypi/l/aenox?style=for-the-badge&color=5865F2)](https://github.com/aenoxic/aenox-api/blob/main/LICENSE)
[![](https://img.shields.io/readthedocs/aenox-api?style=for-the-badge)](https://aenox-api.readthedocs.io/en/latest/)

## ⚙️ Installation
Python 3.10 or higher is required
```
pip install aenox
```

## 🚀 Example Usage
To be able to perform your API query properly, replace `[YOUR_API_KEY]` with a valid API key.

### Example

```python
from aenox import AenoXAPI

api = AenoXAPI(api_key="[YOUR_API_KEY]")
```


## 🫧 Cooldown
You can send 20 queries per second to the API. If you attempt to send another request before this cooldown has passed, you will receive a `aenox.errors.CooldownError`.

### Example
You cannot run this query twice within 2 seconds:
```python
from aenox import AenoXAPI

api = AenoXAPI(api_key="[YOUR_API_KEY]")

api.get_user_stats(user_id=123)
```

In such cases, use `try/except` to handle the error. For example:

```python
from aenox import CooldownError
from aenox import AenoXAPI

api = AenoXAPI(api_key="[YOUR_API_KEY]")

try:
    api.get_user_stats(user_id=123)
except CooldownError:
    print('Cooldown!')
```


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "aenox",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "aenox, discord, bot, api",
    "author": "aenoxic",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/98/6f/1a375365d2f48b0255920d2713177bd11c14c301560024a824ae3ebd5d64/aenox-0.1.6.tar.gz",
    "platform": null,
    "description": "# AenoX API\r\n[![](https://img.shields.io/pypi/v/aenox.svg?style=for-the-badge&logo=pypi&color=yellow&logoColor=white)](https://pypi.org/project/aenox/)\r\n[![](https://img.shields.io/pypi/l/aenox?style=for-the-badge&color=5865F2)](https://github.com/aenoxic/aenox-api/blob/main/LICENSE)\r\n[![](https://img.shields.io/readthedocs/aenox-api?style=for-the-badge)](https://aenox-api.readthedocs.io/en/latest/)\r\n\r\n## \u2699\ufe0f Installation\r\nPython 3.10 or higher is required\r\n```\r\npip install aenox\r\n```\r\n\r\n## \ud83d\ude80 Example Usage\r\nTo be able to perform your API query properly, replace `[YOUR_API_KEY]` with a valid API key.\r\n\r\n### Example\r\n\r\n```python\r\nfrom aenox import AenoXAPI\r\n\r\napi = AenoXAPI(api_key=\"[YOUR_API_KEY]\")\r\n```\r\n\r\n\r\n## \ud83e\udee7 Cooldown\r\nYou can send 20 queries per second to the API. If you attempt to send another request before this cooldown has passed, you will receive a `aenox.errors.CooldownError`.\r\n\r\n### Example\r\nYou cannot run this query twice within 2 seconds:\r\n```python\r\nfrom aenox import AenoXAPI\r\n\r\napi = AenoXAPI(api_key=\"[YOUR_API_KEY]\")\r\n\r\napi.get_user_stats(user_id=123)\r\n```\r\n\r\nIn such cases, use `try/except` to handle the error. For example:\r\n\r\n```python\r\nfrom aenox import CooldownError\r\nfrom aenox import AenoXAPI\r\n\r\napi = AenoXAPI(api_key=\"[YOUR_API_KEY]\")\r\n\r\ntry:\r\n    api.get_user_stats(user_id=123)\r\nexcept CooldownError:\r\n    print('Cooldown!')\r\n```\r\n\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Official wrapper for the AenoX API",
    "version": "0.1.6",
    "project_urls": null,
    "split_keywords": [
        "aenox",
        " discord",
        " bot",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "02680f15571073db477008ed23da1cad52ce939f203ca5bb67018a8496d7badc",
                "md5": "6f1b3684486e00a81601fe8451a04e1e",
                "sha256": "24adcf8d1cbde5d9d741fb56a8f011d783282901b6757a21c73f56dd5d9ee876"
            },
            "downloads": -1,
            "filename": "aenox-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6f1b3684486e00a81601fe8451a04e1e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 5197,
            "upload_time": "2025-01-20T02:33:38",
            "upload_time_iso_8601": "2025-01-20T02:33:38.824765Z",
            "url": "https://files.pythonhosted.org/packages/02/68/0f15571073db477008ed23da1cad52ce939f203ca5bb67018a8496d7badc/aenox-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "986f1a375365d2f48b0255920d2713177bd11c14c301560024a824ae3ebd5d64",
                "md5": "6eb0b636a66376b58731d64ca6b86b34",
                "sha256": "dabee1002ab740668b77bd4730bda9b9a04d4de3e80ae16e762363f143ea1d9f"
            },
            "downloads": -1,
            "filename": "aenox-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "6eb0b636a66376b58731d64ca6b86b34",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 4761,
            "upload_time": "2025-01-20T02:33:40",
            "upload_time_iso_8601": "2025-01-20T02:33:40.294063Z",
            "url": "https://files.pythonhosted.org/packages/98/6f/1a375365d2f48b0255920d2713177bd11c14c301560024a824ae3ebd5d64/aenox-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-20 02:33:40",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "aenox"
}