A Python library for the Demisto SDK

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for demistodev from gravatar.com demistodev

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Demisto
  • Tags Demisto
  • Requires: Python >=3.7
Classifiers

Project description

PyPI version CircleCI Language grade: Python Coverage Status

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

  1. Install - pip3 install demisto-sdk

  2. Upgrade - pip3 install --upgrade demisto-sdk

  3. Demisto server demisto-sdk integration - In order that demisto-sdk and Demisto server communicate, perfrom the following steps:

    1. Get an API key for Demisto-server - Settings -> Integrations -> API keys -> Get your Key (copy it, you will be to copy it once)
    2. Add the following parameters to ~/.zshrc and ~/.bash_profile:
    export DEMISTO_BASE_URL=<http or https>://<demisto-server url or ip>:<port>
export DEMISTO_API_KEY=<API key>

    for example:

    export DEMISTO_BASE_URL=http://127.0.0.1:8080
export DEMISTO_API_KEY=XXXXXXXXXXXXXXXXXXXXXX
    1. Reload your terminal before continue.

CLI usage

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

Supported commands:

  1. init
  2. Validate
  3. Lint
  4. Secrets
  5. Unify
  6. Split-yml
  7. Format
  8. Run
  9. Run-playbook
  10. Upload
  11. Download
  12. Generate-docs
  13. Generate-test-playbook
  14. Json-to-outputs
  15. Update-release-notes
  16. openapi-codegen

How to setup development environment?

Follow the guide found here to setup your demisto-sdk-dev virtual environment. The development environment is connected to the branch you are currently using in the SDK repository.

Simply activate it by running workon demisto-sdk-dev. The virtual environment can be deactivated at all times by running deactivate.

Autocomplete

Our CLI supports autocomplete for Linux/MacOS machines, you can turn this feature on by running one of the following: for zsh users run in the terminal

eval "$(_DEMISTO_SDK_COMPLETE=source_zsh demisto-sdk)"

for regular bashrc users run in the terminal

eval "$(_DEMISTO_SDK_COMPLETE=source demisto-sdk)"

License

MIT - See LICENSE for more information.

Contributions

Contributions are welcome and appreciated.
For information regarding contributing, press here. For release guide, press here

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for demistodev from gravatar.com demistodev

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Demisto
  • Tags Demisto
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

1.32.4

1.32.3

1.32.2

1.32.1

1.32.0

1.31.11

1.31.10

1.31.9

1.31.8

1.31.7

1.31.6

1.31.5

1.31.4

1.31.3

1.31.2

1.31.1

1.31.0

1.30.0

1.29.3

1.29.2

1.29.1

1.29.0

1.28.0

1.27.5

1.27.4

1.27.3

1.27.2

1.27.1

1.27.0

1.26.2

1.26.1

1.26.0

1.25.3

1.25.2

1.25.1

1.25.0

1.24.0

1.23.0

1.22.0

1.21.0

1.20.8

1.20.7

1.20.6

1.20.5

1.20.4

1.20.3

1.20.2

1.20.1

1.20.0

1.19.2

1.19.1

1.19.0

1.18.1

1.18.0

1.17.2

1.17.1

1.17.0

1.16.0

1.15.5

1.15.4

1.15.3

1.15.2

1.15.1

1.15.0

1.14.5

1.14.4

1.14.3

1.14.2

1.14.1

1.14.0

1.13.0

1.12.0

1.11.0

1.10.6

1.10.5

1.10.4

1.10.3

1.10.2

1.10.1

1.10.0

1.9.0

1.8.3

1.8.2

1.8.1

1.8.0

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.9

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

This version

1.3.0

1.2.19

1.2.18

1.2.17

1.2.16

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.11

1.1.10

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.11.dev0 pre-release

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.9

0.4.8

0.4.7

0.4.6

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.3.10

0.3.9

0.3.8

0.3.7

0.3.6

0.3.5

0.3.4

0.3.3

0.3.2

0.3.1

0.3.0

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.8

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Download files

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

Source Distribution

demisto-sdk-1.3.0.tar.gz (1.9 MB view details)

Uploaded Source

File details

Details for the file demisto-sdk-1.3.0.tar.gz.

File metadata

  • Download URL: demisto-sdk-1.3.0.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.1 requests-toolbelt/0.8.0 tqdm/4.57.0 CPython/3.8.3

File hashes

Hashes for demisto-sdk-1.3.0.tar.gz
Algorithm Hash digest
SHA256 1308ad595424b76796e1ba4689d14d6418bdb4758f002c673db2d58ddbc84371
MD5 99927437d281addbed621e8f221c7d65
BLAKE2b-256 6a73b74664d18f40732181b0c404de17bd143128541de8cc23b2b775a31a5d1e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page