noxii

Name	noxii JSON
Version	0.2.2 JSON
	download
home_page	None
Summary	Official wrapper for the Noxii API
upload_time	2024-08-27 16:30:57
maintainer	None
docs_url	None
author	aenoxic
requires_python	>=3.10
license	MIT
keywords	noxii noxiibot api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

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

### Sync Example

```python
from noxii import api

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

api.test()  # Prints "Success!" if it is installed correctly
```


## 🫧 Cooldown
The API has a 10-second cooldown period for each query. This means you must wait 10 seconds between two requests. If you attempt to send another request before this time has passed, you will receive a `noxii.errors.CooldownError`.

### Example
You cannot run this query twice within 10 seconds:
```python
from noxii import api

api = NoxiiAPI(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 noxii import CooldownError
from noxii import api

api = NoxiiAPI(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": "noxii",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "noxii, noxiibot, api",
    "author": "aenoxic",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/eb/37/31b8eb95d35ff62e1143435a05198564922b1bd6cee592c18fd77906f1eb/noxii-0.2.2.tar.gz",
    "platform": null,
    "description": "## \u2699\ufe0f Installation\r\nPython 3.10 or higher is required\r\n```\r\npip install noxii\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### Sync Example\r\n\r\n```python\r\nfrom noxii import api\r\n\r\napi = NoxiiAPI(api_key=\"[YOUR_API_KEY]\")\r\n\r\napi.test()  # Prints \"Success!\" if it is installed correctly\r\n```\r\n\r\n\r\n## \ud83e\udee7 Cooldown\r\nThe API has a 10-second cooldown period for each query. This means you must wait 10 seconds between two requests. If you attempt to send another request before this time has passed, you will receive a `noxii.errors.CooldownError`.\r\n\r\n### Example\r\nYou cannot run this query twice within 10 seconds:\r\n```python\r\nfrom noxii import api\r\n\r\napi = NoxiiAPI(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 noxii import CooldownError\r\nfrom noxii import api\r\n\r\napi = NoxiiAPI(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 Noxii API",
    "version": "0.2.2",
    "project_urls": null,
    "split_keywords": [
        "noxii",
        " noxiibot",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5e066c56684343c11f25af49801f0aae118f44c25bd3a5356e7ccfd1ab7dc34e",
                "md5": "9edae9752f73edebd083be80e5ece2b1",
                "sha256": "3c5352272d8e2aba013d4237a5890fea2db4c9ae254b47f6a89a31f7d049e39a"
            },
            "downloads": -1,
            "filename": "noxii-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9edae9752f73edebd083be80e5ece2b1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 5057,
            "upload_time": "2024-08-27T16:30:55",
            "upload_time_iso_8601": "2024-08-27T16:30:55.059703Z",
            "url": "https://files.pythonhosted.org/packages/5e/06/6c56684343c11f25af49801f0aae118f44c25bd3a5356e7ccfd1ab7dc34e/noxii-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eb3731b8eb95d35ff62e1143435a05198564922b1bd6cee592c18fd77906f1eb",
                "md5": "1a3aca0a6092191bed3306e74b4238a3",
                "sha256": "9d786d7493740131a20b60446f035572858b5f8f0249132ce8736afb4b41950b"
            },
            "downloads": -1,
            "filename": "noxii-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "1a3aca0a6092191bed3306e74b4238a3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 4276,
            "upload_time": "2024-08-27T16:30:57",
            "upload_time_iso_8601": "2024-08-27T16:30:57.852198Z",
            "url": "https://files.pythonhosted.org/packages/eb/37/31b8eb95d35ff62e1143435a05198564922b1bd6cee592c18fd77906f1eb/noxii-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-27 16:30:57",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "noxii"
}