CLI Documentation#

Overview#

This page contains the complete documentation for the Data Curator command-line interface (CLI), including all available commands, options, and usage examples.

Usage#

Below is the entry point for the CLI. Run kaxanuk.data_curator --help to see all commands, or kaxanuk.data_curator <command> --help for details on a specific command.

kaxanuk.data_curator#

Entrypoint required for the click library, body can be empty.

Usage

kaxanuk.data_curator [OPTIONS] COMMAND [ARGS]...

Options

--version#: Show the version and exit.

autorun#

Install the required files and directories for the Excel entry script if missing, otherwise run the system.

Usage

kaxanuk.data_curator autorun [OPTIONS]

init#

Create the files and folders required by the specified configuration format.

Parameters#

config_format: The name of the configuration format to be initialized
entry_script: The name of the entry script that will be generated

Usage

kaxanuk.data_curator init [OPTIONS] {excel}

Options

--entry_script <entry_script>#: The name of the entry script that will be generated. Default: __main__.py

Arguments

CONFIG_FORMAT#: Required argument

run#

Run the system.

If passed any string arguments, each one needs to be the path to an entry script (or to a directory with a __main__.py entry script) that will be executed. If called without arguments, the entry script in the current directory will be run.

Parameters#

entry_script_locations: The locations of the entry scripts that will be executed

Usage

kaxanuk.data_curator run [OPTIONS] [ENTRY_SCRIPT_LOCATIONS]...

Arguments

ENTRY_SCRIPT_LOCATIONS#: Optional argument(s)

update#

Update the configuration files for the specified format.

Parameters#

config_format: The name of the configuration format to be reinitialized

Usage

kaxanuk.data_curator update [OPTIONS] {excel|entry_script}

Arguments

CONFIG_FORMAT#: Required argument

Commands#

autorun#

Installs required files and directories for the Excel entry script if missing; otherwise runs the system.

init#

Creates all files and folders required by the specified configuration format.

Arguments: - CONFIG_FORMAT (required, choices: excel): The configuration format to initialize.

Options: - --entry_script <name>.py: Name of the entry script to generate. Defaults to __main__.py.

run#

Runs the system. If no arguments are provided, it looks for __main__.py in the current directory; otherwise, each argument must be a path to an entry script (or a directory containing __main__.py).

Arguments: - ENTRY_SCRIPT_LOCATIONS (0 or more): Path(s) to entry script file(s) or directories.

update#

Updates configuration files for the specified format.

Arguments: - CONFIG_FORMAT (required, choices: excel, entry_script): The configuration format to update.

Examples#

Initialize a new Excel configuration (creates Config/, Output/ and a new __main__.py):

$ kaxanuk.data_curator init excel
Initializing data curator with format: excel
Created directory Config
Created directory Output
Installed all files successfully

Run the system using the default entry script:

$ kaxanuk.data_curator run
Running...  # (or appropriate output from __main__.py)

Run the system on a specific entry script in another folder:

$ kaxanuk.data_curator run path/to/project/__main__.py
Running...  # (or appropriate output from that __main__.py)

Update only the entry script to the latest template:

$ kaxanuk.data_curator update entry_script
Updated entry script

Install or run the Excel entry script (if __main__.py is missing, it will install; otherwise run):

$ kaxanuk.data_curator autorun
Installed all files successfully. Please configure the files in the Config folder and run again