`cyclonedx_py.client`

Module Contents

Classes

`_CLI_OUTPUT_FORMAT`	Generic enumeration.
`CycloneDxCmd`

Functions

main(prog_name: Optional[str] = None) → None

Attributes

`_output_formats`
`_output_default_filenames`

exception cyclonedx_py.client.CycloneDxCmdException[source]

Bases: Exception

Common base class for all non-exit exceptions.

exception cyclonedx_py.client.CycloneDxCmdNoInputFileSupplied[source]

Bases: CycloneDxCmdException

Common base class for all non-exit exceptions.

class cyclonedx_py.client._CLI_OUTPUT_FORMAT[source]

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

XML = xml[source]

JSON = json[source]

cyclonedx_py.client._output_formats[source]

cyclonedx_py.client._output_default_filenames[source]

class cyclonedx_py.client.CycloneDxCmd(args: argparse.Namespace)[source]

_DEBUG_ENABLED :bool = False[source]

_arguments :argparse.Namespace[source]

_get_output_format(self) → _CLI_OUTPUT_FORMAT[source]

get_output(self) → cyclonedx.output.BaseOutput[source]

execute(self) → None[source]

static get_arg_parser(prog: Optional[str] = None) → argparse.ArgumentParser[source]

_debug_message(self, message: str) → None[source]

static _error_and_exit(message: str, exit_code: int = 1) → None[source]

_get_input_parser(self) → cyclonedx.parser.BaseParser[source]

cyclonedx_py.client.main(prog_name: Optional[str] = None) → None[source]