Skip to main content

A Python library for the Demisto SDK

Project description

PyPI version CircleCI Language grade: Python

Demisto SDK

The Demisto SDK library can be used to manage your Demisto content with ease and efficiency. The library uses python 3.7+.

Usage

Installation

pip install demisto-sdk

CLI

You can use the SDK in the CLI as follows: demisto-sdk <command> <args>.
For more information, run demisto-sdk -h.
For more information on a specific command execute demisto-sdk <command> -h.

Commands

Unify

Unify code, image and description files to a single Demisto yaml file.
Arguments:

  • -i, --indir
    The path to the directory in which the files reside
  • -o, --outdir
    The path to the directory into which to write the unified yml file

Examples:
demisto-sdk unify -i Integrations/MyInt -o Integrations
This will grab the integration components and unify them to a single yaml file.

Extract

Extract code, image and description files from a demisto integration or script yml file.
Arguments:

  • -i INFILE, --infile INFILE
    The yml file to extract from
  • -o OUTFILE, --outfile OUTFILE
    The output file or dir (if doing migrate) to write the code to
  • -m, --migrate
    Migrate an integration to package format. Pass to -o option a directory in this case.
  • -t {script,integration}, --type {script,integration}
    Yaml type. If not specified will try to determine type based upon path.
  • -d {True,False}, --demistomock {True,False}
    Add an import for demisto mock, true by default
  • -c {True,False}, --commonserver {True,False}
    Add an import for CommonServerPython. If not specified will import unless this is CommonServerPython

Examples:
demisto-sdk extract -i Integrations/integration-MyInt.yml -o Integrations/MyInt -m
This will split the yml file to a directory with the integration components (code, image, description, pipfile etc.)

Validate

Validate your content files.
Arguments:

  • -c CIRCLE, --circle CIRCLE
    Is CircleCi or not
  • -b BACKWARD_COMP, --backward-comp BACKWARD_COMP
    To check backward compatibility.
  • -t TEST_FILTER, --test-filter TEST_FILTER
    Check that tests are valid.
  • -j, --conf-json
    Validate the conf.json file.
  • -i, --id-set
    Create the id_set.json file.
  • -p PREV_VER, --prev-ver PREV_VER
    Previous branch or SHA1 commit to run checks against.
  • -g, --use-git
    Validate changes using git.

Examples:
demisto-sdk validate
This will validate your content files.

Lint

Run lintings (flake8, mypy, pylint) and pytest. pylint and pytest will run within the docker image of an integration/script. Meant to be used with integrations/scripts that use the folder (package) structure. Will lookup up what docker image to use and will setup the dev dependencies and file in the target folder.
Arguments:

  • -d DIR, --dir DIR
    Specify directory of integration/script (default: None)
  • --no-pylint
    Do NOT run pylint linter (default: False)
  • --no-mypy
    Do NOT run mypy static type checking (default: False)
  • --no-flake8
    Do NOT run flake8 linter (default: False)
  • --no-test
    Do NOT test (skip pytest) (default: False)
  • -r, --root
    Run pytest container with root user (default: False)
  • -k, --keep-container
    Keep the test container (default: False)
  • -v, --verbose
    Verbose output (default: False)
  • --cpu-num CPU_NUM
    Number of CPUs to run pytest on (can set to auto for automatic detection of the number of CPUs.) (default: 0)

Examples:
demisto-sdk lint -d Integrations/PaloAltoNetworks_XDR --no-mypy
This will run the linters, excluding mypy, on the python files inside the "Integrations/PaloAltoNetworks_XDR" directory.

Secrets

Run Secrets validator to catch sensitive data before exposing your code to public repository. Attach full path to whitelist to allow manual whitelists. Default file path to secrets is "./Tests/secrets_white_list.json".
Arguments:

  • -c CIRCLE, --circle CIRCLE
    Is CircleCi or not (default: False)
  • -wl WHITELIST, --whitelist WHITELIST
    Full path to whitelist file, file name should be "secrets_white_list.json" (default: ./Tests/secrets_white_list.json)

Examples:
demisto-sdk secrets
This will run the secrets validator on your files.

Create

Create content artifacts.
Arguments:

  • -a ARTIFACTS_PATH, --artifacts_path ARTIFACTS_PATH
    The path of the directory in which you want to save the created content artifacts
  • -p, --preserve_bundles
    Flag for if you'd like to keep the bundles created in the process of making the content artifacts

Examples:
demisto-sdk create -a .
This will create content artifacts in the current directory.

In the code

You can import the SDK core class in your python code as follows:

from demisto_sdk.core import DemistoSDK

Dev Environment Setup

We build for python 3.7 and 3.8. We use tox for managing environments and running unit tests.

Install tox:

pip install tox

List configured environments:

tox -l

Then setup dev virtual envs for python 3 (will also install all necessary requirements):

tox --devenv venv3 --devenv py37

Running Unit Tests

We use pytest to run unit tests. Inside a virtual env you can run unit test using: Note that the working directory of the project must be the root directory '$PROJECT_PATH/'.

python -m pytest -v

Additionally, our build uses tox to run on multiple envs. To use tox to run on all supported environments (py37, py38), run:

tox -q  

To run on a specific environment, you can use:

tox -q -e py37

License

MIT - See LICENSE for more information.

Contributing

Contributions are welcome and appreciated.

Development

You can read the following docs to get started:

Development Guide

Validation Testing

Push changes to GitHub

The Demisto SDK is MIT Licensed and accepts contributions via GitHub pull requests. If you are a first time GitHub contributor, please look at these links explaining on how to create a Pull Request to a GitHub repo:

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Review Process

A member of the team will be assigned to review the pull request. Comments will be provided by the team member as the review process progresses.

You will see a few GitHub Status Checks that help validate that your pull request is according to our standards:

  • ci/circleci: build: We use CircleCI to run a full build on each commit of your pull request. The build will run our content validation hooks, linting and unit test. We require that the build pass (green build). Follow the details link of the status to see the full build UI of CircleCI.
  • LGTM analysis: Python: We use LGTM for continues code analysis. If your PR introduces new LGTM alerts, the LGTM bot will add a comment with links for more details. Usually, these alerts are valid and you should try to fix them. If the alert is a false positive, specify this in a comment of the PR.
  • license/cla: Status check that all contributors have signed our contributor license agreement (see below).

Contributor License Agreement

Before merging any PRs, we need all contributors to sign a contributor license agreement. By signing a contributor license agreement, we ensure that the community is free to use your contributions.

When you contribute a new pull request, a bot will evaluate whether you have signed the CLA. If required, the bot will comment on the pull request, including a link to accept the agreement. The CLA document is available for review as a PDF.

If the license/cla status check remains on Pending, even though all contributors have accepted the CLA, you can recheck the CLA status by visiting the following link (replace [PRID] with the ID of your PR): https://cla-assistant.io/check/demisto/demisto-sdk?pullRequest=[PRID] .

If you have a suggestion or an opportunity for improvement that you've identified, please open an issue in this repo. Enjoy and feel free to reach out to us on the DFIR Community Slack channel, or at info@demisto.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for demisto-sdk, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size demisto-sdk-0.1.6.tar.gz (221.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page