pdstools.cli¶

Attributes¶

`APPS`
`ALIASES`

Functions¶

`create_parser`()	Create parser.
`check_for_typos`(unknown_args, known_args)	Check if unknown arguments might be typos of known pdstools arguments.
`list_apps`(→ None)	Print one line per app: `<key>\t<display_name>\t<aliases>`.
`doctor`(→ None)	Print environment health information for support diagnostics.
`main`()	Main.
`run`(args, unknown)	Run.

Module Contents¶

APPS¶

ALIASES¶

create_parser()¶: Create parser.

check_for_typos(unknown_args, known_args)¶

Check if unknown arguments might be typos of known pdstools arguments.

Parameters:

unknown_args (list[str]) – List of unknown arguments from parse_known_args.
known_args (list[str]) – List of known pdstools argument names (with --).

Returns:

(typo, suggestion, similarity) tuples for likely typos.

Return type:

list[tuple[str, str, float]]

list_apps() → None¶

Print one line per app: <key>\t<display_name>\t<aliases>.

Return type:: None

doctor() → None¶

Print environment health information for support diagnostics.

Thin wrapper over pdstools.show_versions() with all diagnostic flags enabled. Exposed as the pdstools doctor CLI subcommand so users can share their environment without writing Python.

Return type:: None

main()¶: Main.

run(args, unknown)¶: Run.