All command line options

Top-level

python -m sympathy --help

usage: sympathy [-h]
                   {gui,cli,viewer,install,uninstall,tests,clear,launch}
                   ...

Sympathy for Data

optional arguments:
  -h, --help            show this help message and exit
  --version             show Sympathy for Data version and exit

Commands:
  {gui,cli,viewer,install,uninstall,tests,clear,launch}
                        Command
    gui                 run Sympathy in GUI mode
    cli                 run Sympathy in CLI mode
    viewer              run the viewer for sydata files.
    install             install Sympathy (start menu, file associations,
                        documentation)
    uninstall           uninstall Sympathy (start menu, file associations)
    tests               run the test suite
    clear               cleanup temporary files
    launch              internal use only

Gui and Cli

The options for the gui and cli commands are similar.

python -m sympathy gui --help

usage: __main__.py gui [-h] [--exit-after-exception {0,1}]
                       [-L LOGGER [LEVEL ...]]
                       [--num-worker-processes NUM_WORKER_PROCESSES]
                       [-I INIFILE] [--nocapture]
                       [filename]

positional arguments:
filename              file containing workflow.

optional arguments:
-h, --help            show this help message and exit
--exit-after-exception {0,1}
                      exit after uncaught exception occurs in a signal handler
-L LOGGER [LEVEL ...],
--loglevel LOGGER [LEVEL ...]
                      A logger configuration with a logger name and a level
                      (e.g. -L app.stats warning). This argument can be
                      repeated.
--num-worker-processes NUM_WORKER_PROCESSES
                      number of python worker processes (0) use system number
                      of CPUs
-I INIFILE,
--inifile INIFILE
                      settings ini-file to use instead of the default
--environment-credentials PREFIX
                      read credential secrets from environment
                      variables starting with PREFIX that are encoded as
                      json lists, with json dictionary values e.g,
                      PREFIX["secret","foo"]={"secret":"bar"}.
--nocapture           disable capturing of node output and send it directly to
                      stdout/stderr.

usage: launch.py gui [-h] [--exit-after-exception {0,1}] [-v]
                     [-L {0,1,2,3,4,5}] [-N {0,1,2,3,4,5}]
                     [--num-worker-processes NUM_WORKER_PROCESSES]
                     [-C CONFIGFILE [CONFIGFILE ...]] [-I INIFILE]
                     [--nocapture]
                     [filename]

positional arguments:
  filename              file containing workflow.

optional arguments:
  -h, --help            show this help message and exit
  --exit-after-exception {0,1}, --exit_after_exception {0,1}
                        exit after uncaught exception occurs in a signal
                        handler
  -L LEVEL, --loglevel LEVEL
                        the sympathy logger configuration level
                        (e.g. -L warning).
  --logger LOGGER LEVEL
                        a logger configuration with a logger name and a
                        level (e.g. --logger app.stats warning). This
                        argument can be repeated.
  --logging-config-file CONFIG-FILE
                        logging config json-file with logging configuration
                        in dictionary format for use with
                        logging.config.dictConfig
  --num-worker-processes NUM_WORKER_PROCESSES, --num_worker_processes NUM_WORKER_PROCESSES
                        number of python worker processes (0) use system
                        number of CPUs
  -C CONFIGFILE [CONFIGFILE ...], --configfile CONFIGFILE [CONFIGFILE ...]
                        workflow configuration file, used to change parameters
                        and an optional outfile for the modified workflow
  -I INIFILE, --inifile INIFILE
                        settings ini-file to use instead of the default
  --environment-credentials PREFIX
                        read credential secrets from environment
                        variables starting with PREFIX that are encoded as
                        json lists, with json dictionary values e.g,
                        PREFIX["secret","foo"]={"secret":"bar"}.
  --nocapture           disable capturing of node output and send it directly
                        to stdout/stderr.

Viewer

python -m sympathy viewer --help

usage: sympathy viewer [-h] [filename]

positional arguments:
  filename    sydata file

optional arguments:
  -h, --help  show this help message and exit

Install

python -m sympathy install --help

usage: sympathy install [-h] [--generate-all] [--compile] [--compile-all]
                        [--register] [--set-preference OPT-NAME OPT-VALUE]
                        [--all]

optional arguments:
  -h, --help            show this help message and exit
  --generate-all        generate parser files
  --compile             compile sympathy
  --compile-all         compile all site-package files
  --register            register desktop application and create shortcuts
  --set-preference OPT-NAME OPT-VALUE
                        set value of setting
  --locate ITEM         locate item (e.g, --locate inifile)
  --all                 perform full installation, includes all options,
                        except --set-preference and --locate, if enabled or
                        by default if no other options are provided

Uninstall

python -m sympathy uninstall --help

usage: sympathy uninstall [-h]

optional arguments:
  -h, --help  show this help message and exit

Clear

python -m sympathy clear --help

usage: sympathy clear [-h] [--caches] [--sessions]

optional arguments:
  -h, --help  show this help message and exit
  --caches    Clear caches for Sympathy.
  --sessions  Clear sessions for Sympathy.