{ "info": { "author": "Charles Butler", "author_email": "chuck@vapor.io", "bugtrack_url": null, "classifiers": [], "description": "# AIONetbox\n\nAn async web client for [Netbox](https://github.com/netbox-community/netbox)\n\n\n### Note\n\nThis library currently only supports read operations. PUT/POST support will\nbe coming in a future release of the library.\n\n## Installation\n\nAIONetbox is distributed as a library intended to be included in other async\npython projects. It has been developed on python 3.6+. aionetbox is published\non the cheese shop for ease of use.\n\ninstallation can be as easy as:\n```shell\npip install aionetbox\n```\n\nor use your virtualenv/tox tooling to guide you.\n\n## Example Usage\n\nThe idea behind AIONetbox is not to abstract the netbox classes with assumptions\nbut instead offer a non-blocking client for async frameworks. its expected that\nthe developer consuming AIONetbox will be at least a little familiar with the\nAPI structure of netbox. If not, the following is a good resource to use when\ncalculating your API routes to query:\n\n- [API Overview](https://github.com/netbox-community/netbox/blob/develop/docs/api/overview.md)\n- [Netbox Documentation](https://netbox.readthedocs.io/en/stable/)\n\nCode Sample for a READ device scan:\n\n```python\nimport asyncio\nimport json\nfrom aionetbox include AIONetbox\n\nasync def run(token):\n # Initialize with the host, and your authentication token\n nbox = AIONetbox(host='https://netbox.example.com', auth_token=token)\n # Provide the api-route you wish to poll, and any key/value args\n devices = await nbox.get('/dcim/devices', role='some-role')\n # be tidy and close your connection when complete\n await nbox.close()\n print(json.dumps(devices, indent=2))\n\n# this is setup so we have an event loop and can leverage asyncio\nif __name__ == '__main__':\n LOOP = asyncio.get_event_loop()\n LOOP.run_until_complete(run('my-netbox-token'))\n```\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/vapor-ware/aionetbox", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "aionetbox", "package_url": "https://pypi.org/project/aionetbox/", "platform": "", "project_url": "https://pypi.org/project/aionetbox/", "project_urls": { "Homepage": "https://github.com/vapor-ware/aionetbox" }, "release_url": "https://pypi.org/project/aionetbox/0.1.0/", "requires_dist": [ "aiohttp (==3.6.0)" ], "requires_python": ">=3.6", "summary": "AIO Netbox", "version": "0.1.0" }, "last_serial": 5821562, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "af1ef1f6c5d0c1b0687d3583f14bf451", "sha256": "3388c875fe50b058c7116700e31fd71f23d99258ef997f66ca549b4d3cdcabe2" }, "downloads": -1, "filename": "aionetbox-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "af1ef1f6c5d0c1b0687d3583f14bf451", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5552, "upload_time": "2019-09-12T16:59:17", "url": "https://files.pythonhosted.org/packages/07/47/f68cdf5861830b83b8e355a0ad42dee17e2d760122f0ef45a7503c234f6e/aionetbox-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b02f1f97c843b57de667242e974237d5", "sha256": "bdfa33f534112ffe42723715cd95f94b2d546ab2fca8fb4856f930b7678b420f" }, "downloads": -1, "filename": "aionetbox-0.1.0.tar.gz", "has_sig": false, "md5_digest": "b02f1f97c843b57de667242e974237d5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4444, "upload_time": "2019-09-12T16:59:19", "url": "https://files.pythonhosted.org/packages/75/c4/1cb4913b83b8b8c8978a4ad30bc61f18a83f7dd15de6cb50e4e749b7f995/aionetbox-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "af1ef1f6c5d0c1b0687d3583f14bf451", "sha256": "3388c875fe50b058c7116700e31fd71f23d99258ef997f66ca549b4d3cdcabe2" }, "downloads": -1, "filename": "aionetbox-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "af1ef1f6c5d0c1b0687d3583f14bf451", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5552, "upload_time": "2019-09-12T16:59:17", "url": "https://files.pythonhosted.org/packages/07/47/f68cdf5861830b83b8e355a0ad42dee17e2d760122f0ef45a7503c234f6e/aionetbox-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b02f1f97c843b57de667242e974237d5", "sha256": "bdfa33f534112ffe42723715cd95f94b2d546ab2fca8fb4856f930b7678b420f" }, "downloads": -1, "filename": "aionetbox-0.1.0.tar.gz", "has_sig": false, "md5_digest": "b02f1f97c843b57de667242e974237d5", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4444, "upload_time": "2019-09-12T16:59:19", "url": "https://files.pythonhosted.org/packages/75/c4/1cb4913b83b8b8c8978a4ad30bc61f18a83f7dd15de6cb50e4e749b7f995/aionetbox-0.1.0.tar.gz" } ] }