# 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
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/ip-fabric/integrations/python-ipfabric-diagrams",
"name": "ipfabric-diagrams",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "ipfabric,ip-fabric,community-fabric",
"author": "Justin Jeffery",
"author_email": "justin.jeffery@ipfabric.io",
"download_url": "https://files.pythonhosted.org/packages/fe/46/e1caed738459a20d48d84b5509eea2094a817c480645be50cd0e9d089b0b/ipfabric_diagrams-6.5.0.tar.gz",
"platform": null,
"description": "# DEPRECATED AND MERGED INTO `ipfabric` PACKAGE.\n\n**This package has been merged into `ipfabric` and only is pointing to the new location.**\n\n**INSTALLING AFTER `ipfabric==v6.6.0` WILL NOT WORK AND CAN BREAK ENVIRONMENTS.**\n\nipfabric_diagrams is a Python module for connecting to and graphing topologies against an IP Fabric instance.\n\n## About\n\nFounded in 2015, [IP Fabric](https://ipfabric.io/) develops network infrastructure visibility and analytics solution to\nhelp enterprise network and security teams with network assurance and automation across multi-domain heterogeneous\nenvironments. From in-depth discovery, through graph visualization, to packet walks and complete network history, IP\nFabric enables to confidently replace manual tasks necessary to handle growing network complexity driven by relentless\ndigital transformation.\n\n\n## Versioning\n\nStarting with IP Fabric version 5.0.x the python-ipfabric will need to\nmatch your IP Fabric version. The API's are changing and instead of `api/v1` they will now be `api/v5.0`.\n\nVersion 5.1 will have backwards compatability with version 5.0 however 6.0 will not support any 5.x versions.\nBy ensuring that your ipfabric SDK's match your IP Fabric Major Version will ensure compatibility and will continue to work.\n\n## Installation\n\n```\npip install ipfabric-diagrams\n```\n\n## Introduction\n\nThis package is used for diagramming via the API for IP Fabric v4.3.0. \nExamples can be located under [examples](examples/) directory.\n\n## Authentication\nPlease take a look at [python-ipfabric](https://gitlab.com/ip-fabric/integrations/python-ipfabric#authentication) \nfor all authentication options.\n\n```python\nfrom ipfabric.diagrams import IPFDiagram\nipf = IPFDiagram(base_url='https://demo3.ipfabric.io/', auth='token', verify=False, timeout=15)\n```\n\n## Development\n\nIPFabric uses poetry for the python packaging module. Install poetry globally:\n\n```\npip install poetry\n```\n\nTo install a virtual environment run the following command in the root of this directory.\n\n```\npoetry install\n```\n\nTo test and build:\n\n```\npoetry run pytest\npoetry build\n```\n\nPrior to pushing changes run:\n```\npoetry run black ipfabric_diagrams ipfabric\npoetry update\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DEPRECATED: Python package for interacting with IP Fabric Diagrams",
"version": "6.5.0",
"project_urls": {
"Changelog": "https://gitlab.com/ip-fabric/integrations/python-ipfabric-diagrams/-/blob/develop/CHANGELOG.md",
"Homepage": "https://gitlab.com/ip-fabric/integrations/python-ipfabric-diagrams",
"IP Fabric": "https://ipfabric.io/",
"Repository": "https://gitlab.com/ip-fabric/integrations/python-ipfabric-diagrams"
},
"split_keywords": [
"ipfabric",
"ip-fabric",
"community-fabric"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f42b7365a7e353d28b92868b59a8a6d663ee44c0b66d29b4b4aed6f3e2d797be",
"md5": "ad53d3c4081f3e442572fa38e388074f",
"sha256": "ed39191143c4fad57cd727c9b24ffa05b45d1b85434dd3c055e3f838062432c9"
},
"downloads": -1,
"filename": "ipfabric_diagrams-6.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad53d3c4081f3e442572fa38e388074f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 4949,
"upload_time": "2023-11-15T13:30:04",
"upload_time_iso_8601": "2023-11-15T13:30:04.660766Z",
"url": "https://files.pythonhosted.org/packages/f4/2b/7365a7e353d28b92868b59a8a6d663ee44c0b66d29b4b4aed6f3e2d797be/ipfabric_diagrams-6.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe46e1caed738459a20d48d84b5509eea2094a817c480645be50cd0e9d089b0b",
"md5": "aceb156c606b88b7623ab6c311198486",
"sha256": "e44d9ca4a6517debfb49d7acd0cb8bbc922943cce63a1f1c6c1ac57a4ae39e48"
},
"downloads": -1,
"filename": "ipfabric_diagrams-6.5.0.tar.gz",
"has_sig": false,
"md5_digest": "aceb156c606b88b7623ab6c311198486",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 4452,
"upload_time": "2023-11-15T13:30:06",
"upload_time_iso_8601": "2023-11-15T13:30:06.020156Z",
"url": "https://files.pythonhosted.org/packages/fe/46/e1caed738459a20d48d84b5509eea2094a817c480645be50cd0e9d089b0b/ipfabric_diagrams-6.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-15 13:30:06",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ip-fabric",
"gitlab_project": "integrations",
"lcname": "ipfabric-diagrams"
}
JSON