ipfabric-diagrams 6.2.0b1

Python package for interacting with IP Fabric Diagrams

IP Fabric

ipfabric_diagrams is a Python module for connecting to and graphing topologies against an IP Fabric instance.

About

Founded in 2015, IP Fabric develops network infrastructure visibility and analytics solution to help enterprise network and security teams with network assurance and automation across multi-domain heterogeneous environments. From in-depth discovery, through graph visualization, to packet walks and complete network history, IP Fabric enables to confidently replace manual tasks necessary to handle growing network complexity driven by relentless digital transformation.

v7.0.0 Deprecation Notices

In ipfabric>=v7.0.0 the following will be deprecated:

• ipfabric_diagrams package will move to ipfabric.diagrams
• Python 3.7 support will be removed.
• The use of token='<TOKEN>' or username='<USER>', password='<PASS>' in IPFClient() will be removed:
  • Token: IPFClient(auth='TOKEN')
  • User/Pass: IPFClient(auth=('USER', 'PASS'))
  • .env file will only accept IPF_TOKEN or (IPF_USERNAME and IPF_PASSWORD) and not auth

Versioning

Starting with IP Fabric version 5.0.x the python-ipfabric and python-ipfabric-diagrams will need to match your IP Fabric version. The API's are changing and instead of api/v1 they will now be api/v5.0.

Version 5.1 will have backwards compatability with version 5.0 however 6.0 will not support any 5.x versions. By ensuring that your ipfabric SDK's match your IP Fabric Major Version will ensure compatibility and will continue to work.

Installation

pip install ipfabric-diagrams

Introduction

This package is used for diagramming via the API for IP Fabric v4.3.0.
Examples can be located under examples directory.

Authentication

Please take a look at python-ipfabric for all authentication options.

from ipfabric.diagrams import IPFDiagram
ipf = IPFDiagram(base_url='https://demo3.ipfabric.io/', auth='token', verify=False, timeout=15)

Development

IPFabric uses poetry for the python packaging module. Install poetry globally:

pip install poetry

To install a virtual environment run the following command in the root of this directory.

poetry install

To test and build:

poetry run pytest
poetry build

Prior to pushing changes run:

poetry run black ipfabric_diagrams ipfabric
poetry update