ipfabric-diagrams 1.1.1

Python package for interacting with IP Fabric Diagrams

IPFabric

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.

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/', token='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

GitHub Actions will publish and release. Make sure to tag your commits:

• ci: Changes to our CI configuration files and scripts
• docs: No changes just documentation
• test: Added test cases
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
• feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
• BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.