imednet.cli.utils package

CLI utility functions and classes.

imednet.cli.utils.display_list(items, label, empty_msg=None, fields=None)[source]

Display a list of items.

Return type:

None

Parameters:

  • items (Sequence[Any]) –

  • label (str) –

  • empty_msg (str | None) –

  • fields (list[str] | None) –

imednet.cli.utils.fetching_status(name, study_key=None)[source]

Context manager to show a spinner while fetching data.

Return type:

Iterator[None]

Parameters:

  • name (str) –

  • study_key (str | None) –

imednet.cli.utils.get_sdk()[source]

Initialize and return the SDK instance using load_config().

Return type:

ImednetSDK

imednet.cli.utils.parse_filter_args(filter_args)[source]

Parse a list of key=value strings into a dictionary.

Return type:

Optional[dict[str, Any]]

Parameters:

filter_args (list[str] | None) –

imednet.cli.utils.register_list_command(parser, attr, name, *, requires_study_key=True, empty_msg=None, summary_fields=None)[source]

Attach a standard list command to parser.

Return type:

None

Parameters:

  • parser (ArgumentParser) –

  • attr (str) –

  • name (str) –

  • requires_study_key (bool) –

  • empty_msg (str | None) –

  • summary_fields (list[str] | None) –

Submodules

imednet.cli.utils.args module

CLI argument parsing utilities.

imednet.cli.utils.args.parse_filter_args(filter_args)[source]

Parse a list of key=value strings into a dictionary.

Return type:

Optional[dict[str, Any]]

Parameters:

filter_args (list[str] | None) –

imednet.cli.utils.commands module

Helpers for registering common CLI commands.

imednet.cli.utils.commands.register_list_command(parser, attr, name, *, requires_study_key=True, empty_msg=None, summary_fields=None)[source]

Attach a standard list command to parser.

Return type:

None

Parameters:

  • parser (ArgumentParser) –

  • attr (str) –

  • name (str) –

  • requires_study_key (bool) –

  • empty_msg (str | None) –

  • summary_fields (list[str] | None) –

imednet.cli.utils.context module

CLI context and SDK initialization helpers.

imednet.cli.utils.context.fetching_status(name, study_key=None)[source]

Context manager to show a spinner while fetching data.

Return type:

Iterator[None]

Parameters:

  • name (str) –

  • study_key (str | None) –

imednet.cli.utils.context.get_sdk()[source]

Initialize and return the SDK instance using load_config().

Return type:

ImednetSDK

imednet.cli.utils.export module

CLI utilities for exporting data to files.

class imednet.cli.utils.export.Model[source]

Bases: Protocol

Protocol for objects that can be dumped to a dictionary.

__init__(*args, **kwargs)
model_dump(*, by_alias=False)[source]

Dump the model to a dictionary.

Return type:

dict[str, Any]

Parameters:

by_alias (bool) –

imednet.cli.utils.export.export_list_to_file(items, filename_prefix, output_format)[source]

Export a list of Pydantic models to a file.

Return type:

None

Parameters:

  • items (Sequence[Model]) –

  • filename_prefix (str) –

  • output_format (str) –

imednet.cli.utils.output module

CLI output formatting and display utilities.

imednet.cli.utils.output.display_list(items, label, empty_msg=None, fields=None)[source]

Display a list of items.

Return type:

None

Parameters:

  • items (Sequence[Any]) –

  • label (str) –

  • empty_msg (str | None) –

  • fields (list[str] | None) –