# Mini IP Fabric Python SDK
## IP Fabric
[IP Fabric](https://ipfabric.io) is a vendor-neutral network assurance platform that automates the
holistic discovery, verification, visualization, and documentation of
large-scale enterprise networks, reducing the associated costs and required
resources whilst improving security and efficiency.
It supports your engineering and operations teams, underpinning migration and
transformation projects. IP Fabric will revolutionize how you approach network
visibility and assurance, security assurance, automation, multi-cloud
networking, and trouble resolution.
**Integrations or scripts should not be installed directly on the IP Fabric VM unless directly communicated from the
IP Fabric Support or Solution Architect teams. Any action on the Command-Line Interface (CLI) using the root, osadmin,
or autoboss account may cause irreversible, detrimental changes to the product and can render the system unusable.**
networking, and trouble resolution.
## Project Description
Minimal Python Client for querying IP Fabric Table or Intent Summary using `requests`.
For full feature client please see [ipfabric](https://pypi.org/project/ipfabric/).
## Versioning
`Major.Minor.Patch`: For best results please match the `Major.Minor` to your IP Fabric installation.
## Installation
```commandline
pip install mini_ipfabric
```
## Configuration/Usage
```python
import os
from mini_ipfabric import IPFClient
ipf = IPFClient(base_url=os.getenv('IPF_URL'), auth=os.getenv('IPF_TOKEN'), verify=True)
print(ipf.technology.keys())
print(ipf.inventory.keys())
data = ipf.fetch_all(endpoint='/inventory/devices', reports=False, filters=None, columns=None)
# endpoint can be API or Web endpoint.
intents = ipf.get_intents()
```
## Support
Please open a ticket on GitLab.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/ip-fabric/integrations/mini-ipfabric",
"name": "mini-ipfabric",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "ipfabric, ip-fabric, community-fabric",
"author": "Justin Jeffery",
"author_email": "justin.jeffery@ipfabric.io",
"download_url": "https://files.pythonhosted.org/packages/32/8d/e5e920d998af2a2f978d26ccdd170b96cafa5f71f0087abc9faf35d8fa45/mini_ipfabric-7.0.0.tar.gz",
"platform": null,
"description": "# Mini IP Fabric Python SDK\n\n## IP Fabric\n\n[IP Fabric](https://ipfabric.io) is a vendor-neutral network assurance platform that automates the \nholistic discovery, verification, visualization, and documentation of \nlarge-scale enterprise networks, reducing the associated costs and required \nresources whilst improving security and efficiency.\n\nIt supports your engineering and operations teams, underpinning migration and \ntransformation projects. IP Fabric will revolutionize how you approach network \nvisibility and assurance, security assurance, automation, multi-cloud \nnetworking, and trouble resolution.\n\n**Integrations or scripts should not be installed directly on the IP Fabric VM unless directly communicated from the\nIP Fabric Support or Solution Architect teams. Any action on the Command-Line Interface (CLI) using the root, osadmin,\nor autoboss account may cause irreversible, detrimental changes to the product and can render the system unusable.**\nnetworking, and trouble resolution.\n\n## Project Description\n\nMinimal Python Client for querying IP Fabric Table or Intent Summary using `requests`.\n\nFor full feature client please see [ipfabric](https://pypi.org/project/ipfabric/).\n\n## Versioning\n\n`Major.Minor.Patch`: For best results please match the `Major.Minor` to your IP Fabric installation.\n\n## Installation\n\n```commandline\npip install mini_ipfabric\n```\n\n## Configuration/Usage\n\n```python\nimport os\nfrom mini_ipfabric import IPFClient\n\nipf = IPFClient(base_url=os.getenv('IPF_URL'), auth=os.getenv('IPF_TOKEN'), verify=True)\n\nprint(ipf.technology.keys())\nprint(ipf.inventory.keys())\n\ndata = ipf.fetch_all(endpoint='/inventory/devices', reports=False, filters=None, columns=None)\n# endpoint can be API or Web endpoint.\n\nintents = ipf.get_intents()\n\n```\n\n## Support\n\nPlease open a ticket on GitLab.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mini Python package for interacting with IP Fabric using requests.",
"version": "7.0.0",
"project_urls": {
"Homepage": "https://gitlab.com/ip-fabric/integrations/mini-ipfabric",
"Repository": "https://gitlab.com/ip-fabric/integrations/mini-ipfabric"
},
"split_keywords": [
"ipfabric",
" ip-fabric",
" community-fabric"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f5a82fc1778d6b446a4f28042b4507ed92b139311379e7de1d28b9dccf511c8",
"md5": "2ff30c269b0cd13655fa3cc017e25777",
"sha256": "d74cf827aae43fc068174536618adbb7717e827b3c8ea1f3ae68c3bc04b009ad"
},
"downloads": -1,
"filename": "mini_ipfabric-7.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2ff30c269b0cd13655fa3cc017e25777",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 171731,
"upload_time": "2024-11-26T19:18:47",
"upload_time_iso_8601": "2024-11-26T19:18:47.439101Z",
"url": "https://files.pythonhosted.org/packages/7f/5a/82fc1778d6b446a4f28042b4507ed92b139311379e7de1d28b9dccf511c8/mini_ipfabric-7.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "328de5e920d998af2a2f978d26ccdd170b96cafa5f71f0087abc9faf35d8fa45",
"md5": "15256cda2fda5b6fc888647f5f3bc637",
"sha256": "e374d510434fbff0f78d5474109e7aaceb2805f90c225a3726927fa14e74a062"
},
"downloads": -1,
"filename": "mini_ipfabric-7.0.0.tar.gz",
"has_sig": false,
"md5_digest": "15256cda2fda5b6fc888647f5f3bc637",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 169373,
"upload_time": "2024-11-26T19:18:49",
"upload_time_iso_8601": "2024-11-26T19:18:49.337606Z",
"url": "https://files.pythonhosted.org/packages/32/8d/e5e920d998af2a2f978d26ccdd170b96cafa5f71f0087abc9faf35d8fa45/mini_ipfabric-7.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 19:18:49",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ip-fabric",
"gitlab_project": "integrations",
"lcname": "mini-ipfabric"
}
JSON