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.

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