https://github.com/vapor-ware/aionetbox

An async HTTP client for Netbox
https://github.com/vapor-ware/aionetbox

aiohttp client netbox

Last synced: 10 days ago
JSON representation

An async HTTP client for Netbox

• Host: GitHub
• URL: https://github.com/vapor-ware/aionetbox
• Owner: vapor-ware
• License: gpl-3.0
• Created: 2019-09-12T14:16:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-14T05:30:33.000Z (12 months ago)
• Last Synced: 2024-12-15T04:24:07.948Z (19 days ago)
• Topics: aiohttp, client, netbox
• Language: Python
• Homepage: https://pypi.org/project/aionetbox/
• Size: 65.4 KB
• Stars: 9
• Watchers: 8
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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)