Insights Packaging APIs
Functionality to support the addition of custom user logic to KX Insights
The KX Insights packaging functionality described here is the mechanism by which users can create, modify and introduce custom user defined logic within KX Insights. This presently is limited to the addition of custom user code but over time will expand to the addition of schemas, pipelines, reports etc. The documentation presented here will provide a user with instructions for the creation, manipulation, upload and use of a package and it's associated APIs. This documentation is intended to provide instructions which are agnostic of the location where a package is being consumed and as such considerations which are specific to interactions within the KX Insights Platform are documented here.
At a basic level a package is a versioned, bundled, collection of files which contains: user code, a manifest file describing the package generated and an initialisation script used as the entry point for loading a package. An in-depth breakdown of the supported components of a package can be found here.
There are three principle means by which a user can interact with a package:
- Command Line Interface - Allows users to create packages, work with them locally and upload to Insights.
- q API - Allows users to interact with packages locally or within an Insights installation using q.
- Python API - Allows users to interact with packages locally or within an Insights installation using Python.