pudl.cli#

A command line interface (CLI) to the main PUDL ETL functionality.

This script cordinates the PUDL ETL process, based on parameters provided via a YAML settings file.

If the settings for a dataset has empty parameters (meaning there are no years or tables included), no outputs will be generated. See Running the ETL Pipeline for details.

The output SQLite and Parquet files will be stored in PUDL_OUT in directories named sqlite and parquet. To setup your default PUDL_IN and PUDL_OUT directories see pudl_setup --help.

Module Contents#

Functions#

parse_command_line(argv)

Parse script command line arguments. See the -h option.

main()

Parse command line and initialize PUDL DB.

Attributes#

logger

pudl.cli.logger[source]#
pudl.cli.parse_command_line(argv)[source]#

Parse script command line arguments. See the -h option.

Parameters:

argv (list) – command line arguments including caller file name.

Returns:

A dictionary mapping command line arguments to their values.

Return type:

dict

pudl.cli.main()[source]#

Parse command line and initialize PUDL DB.