Skip to main content

Plugin spec parser tooling for InsightConnect integrations

Project description

InsightConnect Integrations Plugin Spec

What this is

A tool for parsing a Rapid7 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.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

Project details


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

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page