common_cli

Common dataclass

Common CLI options shared across all commands.

Parameters:

Name	Type	Description	Default
verbose	Annotated[int, Parameter(name=(-v, --verbose), count=True)]	Increase verbosity (use multiple times for more detail).	0
quiet	Annotated[int, Parameter(name=(-q, --quiet), count=True)]	Decrease verbosity (use multiple times for less output).	0

__post_init__()

Automatically configure logging when Common instance is created.

make_stats_relative_to_session_dir(stats_file, session_dir)

Remove occurrences of the session_dir/ prefix from a stats text file.

Parameters:

Name	Type	Description	Default
stats_file	Path	Path to the stats text file to be modified.	required
session_dir	Path	The session directory path to be replaced in the stats file.	required

write_ro_crate(session_dir, start_time, /, *, command_name, command_description, ioargs)

Write RO-Crate metadata for the command execution.

Parameters:

Name	Type	Description	Default
session_dir	Path	Directory where the RO-Crate metadata will be written.	required
start_time	datetime	The start time of the command execution.	required
command_name	str	Name of the command being executed.	required
command_description	str	Description of the command being executed.	required
ioargs	IOArgumentPaths	Input and output arguments for the command execution.	required