resilient-sdk 40.0.100

Python SDK for developing Apps for the IBM Resilient Platform

Recent Changes

2021-02: ver. 40.0

• The function template that is produced when you run 'codegen' now includes references to the resilient-lib library.

• When the var RES_SDK_DEV is set, 'codegen' now creates the payload_samples directory with JSON examples for the Resilient UI and mock results for a "mock server".

• Added '--no-samples' flag to 'package' and when set do not look for the payload_samples directory or try add them to the export.res file.

• Added '--image-hash' flag to 'package' to specify the SHA256 of an image that the app.zip refers to.

IBM Resilient SDK

Table of Contents

• Overview
• Installation
• Usage
• Supported Python Versions
• Documentation
• License and Terms

Overview

The IBM Resilient SDK provides the tools and infrastructure you need to develop Resilient Apps, which you can then post on App Exchange.

Installation

To install the IBM Resilient SDK, simply execute the following command:

$ pip install resilient-sdk

Usage

codegen:

Generate boilerplate code to start developing an app.

$ resilient-sdk codegen -p <name_of_package> -m 'fn_custom_md' --rule 'Rule One' 'Rule Two'

docgen:

Generate documentation for an app.

$ resilient-sdk docgen -p <path_to_package>

extract:

Extract data in order to publish a .res file.

$ resilient-sdk extract -m 'fn_custom_md' --rule 'Rule One' 'Rule Two'

package:

Package an integration into a Resilient app.

$ resilient-sdk package -p <path_to_directory> --display-name "My Custom app"

clone:

Duplicate an existing Action related object (Function, Rule, Script, Message Destination, Workflow) with a new api or display name

$ resilient-sdk clone --workflow <workflow_to_be_cloned> <new_workflow_name>

$ resilient-sdk clone --workflow <workflow_to_be_cloned> <new_workflow_name> --changetype artifact

Supported Python Versions

Python 2.7+ and Python 3.6+

Documentation

For details on the Resilient SDK commands, use the -h option on the command line. For example, resilient-sdk -h and resilient-sdk codegen -h.

The Resilient App Developer's Guide provides information on using the Resilient SDK to develop and package apps. The guide is available on the IBM Knowledge Center at ibm.biz/resilient-docs. On this web page, select your Resilient platform version. On the follow-on page, you can find the App Developer's Guide by expanding Resilient Apps in the Table of Contents pane.

License and Terms

Copyright © IBM Corporation 2020

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.