Skip to main content

The ITSI Command Line Interface (CLI)

Project description

The ITSI Command Line Interface (CLI)

Setup Virtualenv

python3 -m venv /path/to/new/virtual/environment

source /path/to/new/virtual/environment/bin/activate

Install the Python package

pip install itsicli

Using "itsi-use-case"

The itsi-use-case command that is shipped with the Python package assists in creating and managing ITSI Use Cases.

The general end-to-end workflow is as follows:

  1. Initialize a Use Case workspace
  2. Create a Use Case (or optionally import from an ITSI backup file)
  3. Continue to add, remove, or edit content from the Use Case
  4. Add any supporting Splunk knowledge objects (lookups, transforms, props, etc.)
  5. Validate the Use Case through the validate command
  6. Submit the Use Case to either:
    • Splunkbase (must first run the build command)
    • The ITSI Use Case Library via a pull request on Github

An example of creating an ITSI Use Case

TODO

Build the distribution archive

Install the build dependencies:

pip install --upgrade setuptools wheel

Generate the Python package

Run this command to generate the Python distribution archive:

make

Upload to the Python Package Index

Install the dependencies required for uploading to the index:

pip install --upgrade twine

Upload to PyPI:

make upload

Project details


Download files

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

Source Distribution

itsicli-0.0.8.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

itsicli-0.0.8-py3-none-any.whl (23.5 kB view hashes)

Uploaded Python 3

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