Zayo API python client
Project description
Python client for Zayo API
This package provides a python 3.8 asyncio based client to access the Zayo API system.
The following API functional areas are supported:
- Service Inventory
- Maintenance
This package also includes a CLI tool zayocli
to retrieve and display information
obtained via the API.
Installation
pip install pyzayo
Before You Begin
You must export two environment variables for use with this library:
ZAYO_CLIENT_ID
- Your unique client ID valueZAYO_CLIENT_SECRET
- Your unique client secret value
You must obtain these values from Zayo.
Quick Start
from pyzayo import ZayoClient
# create a client to the Maintenace API authenticate using the ZAYO_ variables
zapi = ZayoClient()
# use the instance methods to retrieve data
cases = zapi.get_cases()
Usage Documentation
WORK IN PROGRESS
For now, please use the docstrings by doing:
from pyzayo import ZayoClient
help(ZayoClient)
CLI Tool
The zayocli
tool supports the maintenance cases and service inventory features:
Usage: zayocli [OPTIONS] COMMAND [ARGS]...
Zayo CLI tool to access information via the API.
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
cases Maintenance commands.
services Inventory Service commands.
cases subcommand
Usage: zayocli cases [OPTIONS] COMMAND [ARGS]...
Maintenance commands.
Options:
--help Show this message and exit.
Commands:
list Show listing of maintenance caess.
show-details Show specific case details.
services subcommand
Usage: zayocli services [OPTIONS] COMMAND [ARGS]...
Inventory Service commands.
Options:
--help Show this message and exit.
Commands:
circuit Show service record for given circuit ID.
list List service inventory.
Zayo API Documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyzayo-0.5.0.tar.gz
(13.4 kB
view hashes)
Built Distribution
pyzayo-0.5.0-py3-none-any.whl
(25.0 kB
view hashes)