Metadata-Version: 2.1
Name: demisto-sdk
Version: 1.5.9
Summary: A Python library for the Demisto SDK
Home-page: https://github.com/demisto/demisto-sdk
Author: Demisto
Author-email: 
License: MIT
Description: # Demisto SDK
        
        [![PyPI version](https://badge.fury.io/py/demisto-sdk.svg)](https://badge.fury.io/py/demisto-sdk)
        [![CircleCI](https://circleci.com/gh/demisto/demisto-sdk/tree/master.svg?style=svg)](https://circleci.com/gh/demisto/demisto-sdk/tree/master)
        [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/ppwwyyxx/OpenPano.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/demisto/demisto-sdk/context:python)
        [![Coverage Status](https://coveralls.io/repos/github/demisto/demisto-sdk/badge.svg?branch=master)](https://coveralls.io/github/demisto/demisto-sdk?branch=master)
        
        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`
        1. **Upgrade** - `pip3 install --upgrade demisto-sdk`
        1. **Demisto server demisto-sdk integration** - In order that demisto-sdk and Cortex XSOAR (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)
           1. Add the following parameters to your environment. You can also use a [.env file](https://pypi.org/project/python-dotenv/), the demisto-sdk will automatically load that file.:
        
              ```bash
              export DEMISTO_BASE_URL=<http or https>://<demisto-server url or ip>:<port>
              export DEMISTO_API_KEY=<API key>
              ```
        
              for example:
        
              ```bash
              export DEMISTO_BASE_URL=http://127.0.0.1:8080
              export DEMISTO_API_KEY=XXXXXXXXXXXXXXXXXXXXXX
              ```
        
              >For more configurations, check the [demisto-py](https://github.com/demisto/demisto-py) repository (which is used by the demisto-sdk to communicate with Cortex XSOAR).
        
           1. Reload your terminal before continue.
        
        ---
        
        ### CLI usage
        
        You can use the SDK in the CLI as follows:
        
        ```bash
        demisto-sdk <command> <args>
        ```
        
        For more information, run `demisto-sdk -h`.
        For more information on a specific command execute `demisto-sdk <command> -h`.
        
        ### Version Check
        
        `demisto-sdk` will check against the GitHub repository releases for a new version every time it runs and will issue a warning if you are not using the latest and greatest. If you wish to skip this check you can set the environment variable: `DEMISTO_SDK_SKIP_VERSION_CHECK`. For example:
        
        ```bash
        export DEMISTO_SDK_SKIP_VERSION_CHECK=yes
        ```
        
        ---
        
        ## Commands
        
        Supported commands:
        
        1. [init](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/init/README.md)
        1. [Validate](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/validate/README.md)
        1. [Lint](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/lint/README.md)
        1. [Secrets](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/secrets/README.md)
        1. [Unify](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/unify/README.md)
        1. [Split](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/split/README.md)
        1. [Format](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/format/README.md)
        1. [Run](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/run_cmd/README.md)
        1. [Run-playbook](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/run_playbook/README.md)
        1. [Upload](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/upload/README.md)
        1. [Download](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/download/README.md)
        1. [Generate-docs](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/generate_docs/README.md)
        1. [Generate-test-playbook](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/generate_test_playbook/README.md)
        1. [Generate-outputs](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/generate_outputs/README.md)
        1. [Update-release-notes](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/update_release_notes/README.md)
        1. [Zip-packs](https://github.com/demisto/demisto-sdk/blob/master/demisto_sdk/commands/zip_packs/README.md)
        1. [openapi-codegen](https://xsoar.pan.dev/docs/integrations/openapi-codegen)
        1. [postman-codegen](https://xsoar.pan.dev/docs/integrations/postman-codegen)
        1. [generate-integration](https://xsoar.pan.dev/docs/integrations/code-generator)
        
        ---
        
        ### Customizable command configuration
        
        You can create your own configuration for the `demisto-sdk` commands by creating a file named `.demisto-sdk-conf` within the directory from which you run the commands.
        This file will enable you to set a default value to the existing command flags that will take effect whenever the command is run.
        This can be done by entering the following structure into the file:
        
        ```INI
        [command_name]
        flag_name=flag_default_value
        ```
        
        Note: Make sure to use the flag's full name and input `_` instead of a `-` if it exists in the flag name (e.g. instead of `no-docker-checks` use `no_docker_checks`).
        
        Here are a few examples:
        
        - As a user, I would like to not use the `mypy` linter in my environment when using the `lint` command. In the `.demisto-sdk-conf` file I'll enter:
        
         ```INI
        [lint]
        no_mypy=true
        ```
        
        - As a user, I would like to include untracked git files in my validation when running the `validate` command. In the `.demisto-sdk-conf` file I'll enter:
        
        ```INI
        [validate]
        include_untracked=true
        ```
        
        - As a user, I would like to automatically use minor version changes when running the `update-release-notes` command. In the `.demisto-sdk-conf` file I'll enter:
        
        ```INI
        [update-release-notes]
        update_type=minor
        ```
        
        ---
        
        ### How to setup development environment?
        
        Follow the guide found [here](CONTRIBUTION.md#2-install-demisto-sdk-dev-environment) 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
        
        ```bash
        eval "$(_DEMISTO_SDK_COMPLETE=source_zsh demisto-sdk)"
        ```
        
        for regular bashrc users run in the terminal
        
        ```bash
        eval "$(_DEMISTO_SDK_COMPLETE=source demisto-sdk)"
        ```
        
        ---
        
        ## License
        
        MIT - See [LICENSE](LICENSE) for more information.
        
        ---
        
        ## Contributions
        
        Contributions are welcome and appreciated.
        For information regarding contributing, press [here](CONTRIBUTION.md).
        For release guide, press [here](docs/release_guide.md)
        
Keywords: Demisto
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.7
Description-Content-Type: text/markdown
