Python package for interacting with IP Fabric Diagrams
Project description
IPFabric
IPFabric is a Python module for connecting to and communicating 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
CURRENTLY WIP - Will be released after IP Fabric version 4.3.
Authentication
Basic
Please take a look at basic.py for basic authentication examples
Environment
The easiest way to use this package is with a .env
file. You can copy the sample and edit it with your environment variables.
cp sample.env .env
This contains the following variables which can also be set as environment variables instead of a .env file.
IPF_URL="https://demo3.ipfabric.io"
IPF_TOKEN=TOKEN
IPF_VERIFY=true
IPF_DEV
is an internal variable only, do not set to True.
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.
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
Built Distribution
Hashes for ipfabric_diagrams-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f213191dd9a4bcd6e76b993a51c8962297a3fd3d58dd6a8e713fd8aa0a2fb6a0 |
|
MD5 | d5c57012be5c524a9a73f5b457fd0e54 |
|
BLAKE2b-256 | 4d8fe026788c64aa95a11ab9303006f46544c07b6daa0314b355f771e98aa1b5 |