CLI API

Basics commands

This file will contain the code for script interactions.

It will call commands for the submodules.

qosst_core.commands.main()

This is the actual entrypoint.

It will construct the parser and subparsers for the different command.

qosst_core.commands.info(_args: Namespace) → bool

Print information on the current installation of cvqkd_core

Parameters:: _args (argparse.Namespace) – the args passed to the command line.

The args are not used.

Returns:: this function always returns True.
Return type:: bool

qosst_core.commands.shell(_args: Namespace) → bool

Start a shell.

The shell will be using IPython if available and fallback on the default interactive shell if not.

Parameters:: _args (argparse.Namespace) – the args passed to the command line.

The args are not used.

Returns:: this function always returns True.
Return type:: bool

qosst_core.commands.motd(_args: Namespace) → bool

Print only the motd (logo)

Parameters:: _args (argparse.Namespace) – the args passed to the command line.

The args are not used.

Returns:: this function always returns True.
Return type:: bool

qosst_core.commands.qosst_credits(_args: Namespace) → bool

Print the thank message.

Parameters:: _args (argparse.Namespace) – the args passed to the command line.

The args are not used.

Returns:: this function always returns True.
Return type:: bool

qosst_core.commands.print_hardware(args: Namespace) → bool

Print the hardware of a given HAL module using the utils function list_hardware_str from qosst_hal.

Parameters:: args (argparse.Namespace) – the args passed to the command line.
Returns:: this function always returns True.
Return type:: bool

Configuration commands

This file contains function that will be called from the main command of qosst_core.

qosst_core.configuration.commands.create_configuration_file_command(args: Namespace) → bool

Command to create a configuration file from the config.example.toml file.

Parameters:: args (argparse.Namespace) – args passed from the command line.

The args should contain :

file(str): the path of the file to create.

override(bool): if True, this will override the file at the path if it exists.

Returns:: True if the operation was successful, False otherwise
Return type:: bool

qosst_core.configuration.commands.create_configuration_file(file: str, override: bool = False) → bool

Create a configuration file from the config.example.toml file.

Parameters:

file (str) – the path of the file to create
override (bool, optional) – if True, it will the override at the given path, if it exists. Defaults to False.

Returns:

True if the creation was successful, False otherwise.

Return type:

bool

Authentication commands

QOSST commands for the authentication submodule.

qosst_core.authentication.commands.generate_falcon_key_pair(args: Namespace) → bool

Generate a Falcon key pair (public-private)

Parameters:: args (argparse.Namespace) – args passed to the command line.
Returns:: True if command was successful, False otherwise.
Return type:: bool