Metadata-Version: 2.1
Name: aionetbox
Version: 1.6.1
Summary: Async netbox library
Home-page: https://github.com/vapor-ware/aionetbox
Author: Marco Ceppi
Author-email: marco@vapor.io
License: GNU General Public License v3.0
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: aiohttp[speedups] (<4.0)
Requires-Dist: prance[osv]
Provides-Extra: icu
Requires-Dist: prance[icu,osv] ; extra == 'icu'

# AIO Netbox

An asyncio netbox library that conforms to any running netbox via it's OpenAPI spec

## Installation

AIONetbox is distributed as a library intended to be included in other asyncio python projects. It has been developed on python 3.6+ though 3.8 is recommended.

```
pip install aionetbox
```

## Usage

```
from aionetbox import AIONetbox

netbox = AIONetbox.from_openapi(
    url='http://localhost:8000',
    api_key='0123abcd'
)

sites = await netbox.dcim.dcim_sites_list()
my_site = await netbox.dcim.dcim_sites_read(id=2)

custom_field_sort = await netbox.dcim.dcim_regions_list(cf_sf_id='identifier')
```

Each module and method map to the swagger definition for netbox (`/api/docs`)

![](https://imgur.com/Mhs4UHz.png)


