pudl.ferc_to_sqlite.cli#

A script for cloning the FERC Form 1 database into SQLite.

This script generates a SQLite database that is a clone/mirror of the original FERC Form1 database. We use this cloned database as the starting point for the main PUDL ETL process. The underlying work in the script is being done in pudl.extract.ferc1.

Module Contents#

Functions#

parse_command_line(argv)

Parse command line arguments. See the -h option.

ferc_to_sqlite_job_factory(...)

Factory for parameterizing a reconstructable ferc_to_sqlite job.

main()

Clone the FERC Form 1 FoxPro database into SQLite.

Attributes#

logger

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

Parse command line arguments. See the -h option.

Parameters:

argv (str) – Command line arguments, including caller filename.

Returns:

Dictionary of command line arguments and their parsed values.

Return type:

dict

pudl.ferc_to_sqlite.cli.ferc_to_sqlite_job_factory(logfile: str | None = None, loglevel: str = 'INFO', enable_xbrl: bool = True, enable_dbf: bool = True) → collections.abc.Callable[[], dagster.JobDefinition][source]#

Factory for parameterizing a reconstructable ferc_to_sqlite job.

Parameters:

  • loglevel – The log level for the job’s execution.

  • logfile – Path to a log file for the job’s execution.

  • enable_xbrl – if True, include XBRL data processing in the job.

  • enable_dbf – if True, include DBF data processing in the job.

Returns:

The job definition to be executed.

pudl.ferc_to_sqlite.cli.main()[source]#

Clone the FERC Form 1 FoxPro database into SQLite.