# InsightConnect Integrations Plugin Spec
## What this is
A tool for parsing a
[Rapid7 InsightConnect](https://www.rapid7.com/products/insightconnect/) integration
plugin spec file _(plugin.spec.yaml)_ and interacting with it programmatically.
## Installation
### Install the module via `pip`
```
$ pip install insightconnect-integrations-plugin-spec-tooling
```
## Okay great, but how do I use it
Simple!
```
from typing import Any
from icon_plugin_spec.plugin_spec import KomandPluginSpec, PluginComponent
spec: KomandPluginSpec = KomandPluginSpec(directory="path_to_my_plugin")
raw_connection: {str: Any} = spec.connection() # Dictionary of connection properties
print(raw_connection) # Prints out list of inputs on the connection
# or, do the following
connection: PluginComponent = PluginComponent.new_connection(raw=raw_connection)
print(connection.inputs)
```
## Changelog
* 1.3.2 - Update PyYaml to v6.0.1
* 1.3.1 - Update ruamel.yaml to work with Python 3.9
* 1.3.0 - Add functionality to support plugin tasks
* 1.2.0 - Add functionality to check if a plugin is cloud ready
* 1.1.0 - Add functionality to check if a plugin is obsolete
* 1.0.0 - Initial
Raw data
{
"_id": null,
"home_page": "https://github.com/rapid7/icon-integrations-plugin-spec",
"name": "insightconnect-integrations-plugin-spec-tooling",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Rapid7 Integrations Alliance",
"author_email": "integrationsalliance@rapid7.com",
"download_url": "",
"platform": null,
"description": "\n# InsightConnect Integrations Plugin Spec\n\n## What this is\n\nA tool for parsing a\n[Rapid7 InsightConnect](https://www.rapid7.com/products/insightconnect/) integration\nplugin spec file _(plugin.spec.yaml)_ and interacting with it programmatically.\n\n## Installation\n\n### Install the module via `pip`\n\n```\n$ pip install insightconnect-integrations-plugin-spec-tooling\n```\n\n## Okay great, but how do I use it\n\nSimple!\n\n```\nfrom typing import Any\nfrom icon_plugin_spec.plugin_spec import KomandPluginSpec, PluginComponent\n\nspec: KomandPluginSpec = KomandPluginSpec(directory=\"path_to_my_plugin\")\nraw_connection: {str: Any} = spec.connection() # Dictionary of connection properties\n\nprint(raw_connection) # Prints out list of inputs on the connection\n\n# or, do the following\nconnection: PluginComponent = PluginComponent.new_connection(raw=raw_connection)\nprint(connection.inputs)\n```\n\n## Changelog\n\n* 1.3.2 - Update PyYaml to v6.0.1\n* 1.3.1 - Update ruamel.yaml to work with Python 3.9\n* 1.3.0 - Add functionality to support plugin tasks\n* 1.2.0 - Add functionality to check if a plugin is cloud ready\n* 1.1.0 - Add functionality to check if a plugin is obsolete\n* 1.0.0 - Initial\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Plugin spec parser tooling for InsightConnect integrations",
"version": "1.3.2",
"project_urls": {
"Homepage": "https://github.com/rapid7/icon-integrations-plugin-spec"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "88edd0c7028b8c660ce635242c3bcb8bce400fb0be1bb34f74d952541afacff7",
"md5": "bf34369e4378062be8f0c77206278e8c",
"sha256": "0f7d1f10449abfbb719a15f64cdfdbbe39ea174d908520853e70fc0893e9a21f"
},
"downloads": -1,
"filename": "insightconnect_integrations_plugin_spec_tooling-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf34369e4378062be8f0c77206278e8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8078,
"upload_time": "2023-12-14T16:27:54",
"upload_time_iso_8601": "2023-12-14T16:27:54.103105Z",
"url": "https://files.pythonhosted.org/packages/88/ed/d0c7028b8c660ce635242c3bcb8bce400fb0be1bb34f74d952541afacff7/insightconnect_integrations_plugin_spec_tooling-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 16:27:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rapid7",
"github_project": "icon-integrations-plugin-spec",
"github_not_found": true,
"lcname": "insightconnect-integrations-plugin-spec-tooling"
}
JSON
