Skip to main content

Python 3Di command line client

Project description

The 3Di command line client

The 3Di command line client allows for

  • Defining and running 3Di scenarios from the command line.
  • Assembling different scenarios as a "suite" that will be run in batch.
  • Management commands, for instance to list currently running simulations.

There are three main entry points for the 3Di command line client.

Scenario command

$ scenario --help

Usage: scenario [OPTIONS] COMMAND [ARGS]...

Options:
  --endpoint [localhost|staging|production]
                                  The endpoint where commands are run against
  --help                          Show this message and exit.

Commands:
  auth           Provide authentication details
  models         List available threedimodels
  organisations  List available organisations
  results        Download results of a simulation
  run            Run a given scenario
  scenarios      List local scenarios
  settings       Set default settings
  simulations    List simulations

Suite command

$ suite --help

Usage: suite [OPTIONS]

  run suite a given suite

Options:
  --suite PATH  path to the suite file  [required]
  --help        Show this message and exit.

Active simulations command

$ active_simulations --help

Usage: active_simulations [OPTIONS]

  Show currently running simulations

Options:
  --endpoint [localhost|staging|production]
                                  The endpoint where commands are run against
  --help                          Show this message and exit.

Dependencies

python >= 3.8

Installation

Dependencies python >= 3.8

pip install --user 3Di-cmd-client

======= History

0.0.1 (unreleased)

  • Nothing changed yet.

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 3Di-cmd-client, version 0.0.1a0
Filename, size File type Python version Upload date Hashes
Filename, size 3Di_cmd_client-0.0.1a0-py2.py3-none-any.whl (37.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size 3Di_cmd_client-0.0.1a0.tar.gz (26.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page