semvec/pypi-packages huggingface dataset:
ipfabric-diagrams 6.5.0
DEPRECATED: Python package for interacting with IP Fabric Diagrams
License: MIT
Requires Python: >=3.8.1,<4.0.0
Keywords: ipfabric,ip-fabric,community-fabric

# DEPRECATED AND MERGED INTO `ipfabric` PACKAGE.

**This package has been merged into `ipfabric` and only is pointing to the new location.**

**INSTALLING AFTER `ipfabric==v6.6.0` WILL NOT WORK AND CAN BREAK ENVIRONMENTS.**

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

## About

Founded in 2015, [IP Fabric](https://ipfabric.io/) 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.


## Versioning

Starting with IP Fabric version 5.0.x the python-ipfabric  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](examples/) directory.

## Authentication
Please take a look at [python-ipfabric](https://gitlab.com/ip-fabric/integrations/python-ipfabric#authentication) 
for all authentication options.

```python
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
```