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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
3Di_cmd_client-0.0.1a0.tar.gz
(26.6 kB
view hashes)
Built Distribution
Close
Hashes for 3Di_cmd_client-0.0.1a0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40ce7a107482390d1f88442b891e172e91d503618e6cd133abb8525e641ef03d |
|
MD5 | 2043a701ecafb7f3ec7986bdb9483dd1 |
|
BLAKE2b-256 | ddc83378f00930182ebc07d52641afa0b7a121bb311ead534d23a2112fe25dfa |