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.4 (unreleased)
- Nothing changed yet.
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.
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
threedi_cmd-0.0.1.dev0.tar.gz
(29.6 kB
view details)
Built Distribution
File details
Details for the file threedi_cmd-0.0.1.dev0.tar.gz.
File metadata
- Download URL: threedi_cmd-0.0.1.dev0.tar.gz
- Upload date:
- Size: 29.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2152bd2859baa2083eed571959a1e10dd24e7eefefc04e44a7299e33d6b20d59 |
|
| MD5 | 06bb807043b18f99836d8006273cc1c4 |
|
| BLAKE2b-256 | 3a7f3882cbcc233e260b812d7dcf427578d1714110058de18823ddc7d1dbdaf7 |
File details
Details for the file threedi_cmd-0.0.1.dev0-py2.py3-none-any.whl.
File metadata
- Download URL: threedi_cmd-0.0.1.dev0-py2.py3-none-any.whl
- Upload date:
- Size: 41.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.1 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d714bb3ddaadf77f30d0c587fffe74f47e124d600e369e6848d4d60eef34d090 |
|
| MD5 | c3189133c93bd32a3299b696ace96c8f |
|
| BLAKE2b-256 | 5b388352ab069dc3d2a730730e89ad835c5f5d027759d866d520cbdd83ccf97a |
