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.3 (2020-12-21)
- Fixed settings context if config file is not yet available.
0.0.1b (2020-12-18)
- First (beta) pypi release.
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.3.tar.gz
(26.6 kB
view hashes)
Built Distribution
Close
Hashes for 3Di_cmd_client-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6926957824433e1f8ead59c11cbeb395ec2c832b94cd647a5f43f32dc3e3d8ae |
|
MD5 | 1cf20d3b59271c90af64c283a0ca3738 |
|
BLAKE2b-256 | 9f4683dd45bfcbfb49f5a6380119b445a0b4b4f66336a535462470aaefb792a1 |