pudl.workspace.setup

Tools for setting up and managing PUDL workspaces.

Attributes

logger
PotentialDirectoryPath

Classes

PudlPaths

These settings provide access to various PUDL directories.

Module Contents

pudl.workspace.setup.logger

pudl.workspace.setup.PotentialDirectoryPath

class pudl.workspace.setup.PudlPaths(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, Ellipsis] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_implicit_flags: bool | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: Any)

Bases: pydantic_settings.BaseSettings

These settings provide access to various PUDL directories.

It is primarily configured via PUDL_INPUT and PUDL_OUTPUT environment variables. Other paths of relevance are derived from these.

pudl_input: PotentialDirectoryPath

pudl_output: PotentialDirectoryPath

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

create_directories()

Create PUDL input and output directories if they don’t already exist.

property input_dir: pathlib.Path

Path to PUDL input directory.

property output_dir: pathlib.Path

Path to PUDL output directory.

property settings_dir: pathlib.Path

Path to directory containing settings files.

property data_dir: pathlib.Path

Path to PUDL data directory.

property pudl_db: str

Returns url of locally stored pudl sqlite database.

sqlite_db_uri(name: str) → str

Returns url of locally stored pudl sqlite database with given name.

The name is expected to be the name of the database without the .sqlite suffix. E.g. pudl, ferc1 and so on.

parquet_path(table_name: str | None = None) → pathlib.Path

Return path to parquet file for given database and table.

sqlite_db_path(name: str) → pathlib.Path

Return path to locally stored SQLite DB file.

output_file(filename: str) → pathlib.Path

Path to file in PUDL output directory.

static set_path_overrides(input_dir: str | None = None, output_dir: str | None = None) → None

Set PUDL_INPUT and/or PUDL_OUTPUT env variables.

Parameters:

• input_dir – if set, overrides PUDL_INPUT env variable.

• output_dir – if set, overrides PUDL_OUTPUT env variable.