ferc_xbrl_extractor.cli

A command line interface (CLI) to the xbrl extractor.

Module Contents

Functions

parse()	Process base commands from the CLI.
run_main(instance_path, sql_path, clobber, taxonomy, ...)	Log setup, taxonomy finding, and SQL IO.
main()	Parse arguments and pass to run_main.

Attributes

TAXONOMY_MAP

ferc_xbrl_extractor.cli.TAXONOMY_MAP

ferc_xbrl_extractor.cli.parse()

Process base commands from the CLI.

ferc_xbrl_extractor.cli.run_main(instance_path: pathlib.Path | io.BytesIO, sql_path: pathlib.Path, clobber: bool, taxonomy: pathlib.Path | io.BytesIO | None, entry_point: pathlib.Path, form_number: int | None, metadata_path: pathlib.Path | None, datapackage_path: pathlib.Path | None, workers: int | None, batch_size: int | None, loglevel: str, logfile: pathlib.Path | None, requested_tables: list[str] | None = None, instance_pattern: str = '')

Log setup, taxonomy finding, and SQL IO.

ferc_xbrl_extractor.cli.main()

Parse arguments and pass to run_main.