Subcommand api

See API for more information on usage and available jsonrpc methods.

Make benchmarkstt available through a rudimentary JSON-RPC interface

Attention

Only supported for Python versions 3.6 and above

usage: benchmarkstt-tools api [--debug] [--host HOST] [--port PORT]
                              [--entrypoint ENTRYPOINT] [--list-methods]
                              [--with-explorer]
                              [--log-level {critical,fatal,error,warn,warning,info,debug,notset}]
                              [--load MODULE_NAME [MODULE_NAME ...]] [--help]

Named Arguments

--debug

Run in debug mode

Default: False

--host

Hostname or ip to serve api

--port

Port used by the server

Default: 8080

--entrypoint

The jsonrpc api address

Default: "/api"

--list-methods

List the available jsonrpc methods

Default: False

--with-explorer

Also create the explorer to test api calls with, this is a rudimentary feature currently only meant for testing and debugging. Warning: the API explorer is provided as-is, without any tests or code reviews. This is marked as a low-priority feature.

Default: False

--log-level

Possible choices: critical, fatal, error, warn, warning, info, debug, notset

Set the logging output level

Default: warning

--load

Load external code that may contain additional classes for normalization, etc. E.g. if the classes are contained in a python file named myclasses.py in the directory where your are calling benchmarkstt from, you would pass --load myclasses. All classes that are recognized will be automatically documented in the --help command and available for use.