pudl#

The Public Utility Data Liberation (PUDL) Project.

Submodules#

Attributes#

`PUDL_ROOT_PATH`	Resolved absolute path to the repository root.
`PUDL_SETTINGS_PATH`	Resolved absolute path to the package_data directory.
`PUDL_DBT_PATH`	Resolved absolute path to the dbt directory.
`PUDL_DOCS_PATH`	Resolved absolute path to the docs directory.
`PUDL_NIGHTLY_BUILDS_BASE_PATH`	Base path to PUDL nightly builds outputs.
`PUDL_EEL_HOLE_BASE_PATH`	Base path to eel-hole s3 outputs.
`__author__`
`__contact__`
`__maintainer__`
`__license__`
`__maintainer_email__`
`__version__`
`__docformat__`
`__description__`
`__long_description__`
`__projecturl__`
`__downloadurl__`

Functions#

configure_root_logger(→ None)

Configure the root catalystcoop logger.

Package Contents#

pudl.configure_root_logger(logfile: str | None = None, loglevel: Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] = 'INFO', dependency_loglevels: dict[str, int] | None = None, color_logs: bool = True, propagate: bool = False) → None[source]#

Configure the root catalystcoop logger.

Parameters:

logfile – Path to logfile or None.
loglevel – Level of detail at which to log. Defaults to INFO.
dependency_loglevels – Dictionary mapping dependency name to desired loglevel. This allows us to filter excessive logs from dependencies.
color_logs – Whether to emit ANSI color codes. Defaults to True.
propagate – Whether to propagate logs to ancestor loggers. Useful for ensuring that pytest has access to PUDL logs during testing.

pudl.PUDL_ROOT_PATH: pathlib.Path[source]#: Resolved absolute path to the repository root.

pudl.PUDL_SETTINGS_PATH: pathlib.Path[source]#: Resolved absolute path to the package_data directory.

pudl.PUDL_DBT_PATH: pathlib.Path[source]#: Resolved absolute path to the dbt directory.

pudl.PUDL_DOCS_PATH: pathlib.Path[source]#: Resolved absolute path to the docs directory.

pudl.PUDL_NIGHTLY_BUILDS_BASE_PATH: upath.UPath[source]#: Base path to PUDL nightly builds outputs.

pudl.PUDL_EEL_HOLE_BASE_PATH: upath.UPath[source]#: Base path to eel-hole s3 outputs.

pudl.__author__ = 'Catalyst Cooperative'[source]#

pudl.__contact__ = 'pudl@catalyst.coop'[source]#

pudl.__maintainer__ = 'Catalyst Cooperative'[source]#

pudl.__license__ = 'MIT License'[source]#

pudl.__maintainer_email__ = 'zane.selvans@catalyst.coop'[source]#

pudl.__version__ = '0.0.0.dev0'[source]#

pudl.__docformat__ = 'restructuredtext en'[source]#

pudl.__description__ = 'Tools for liberating public US electric utility data.'[source]#

pudl.__long_description__ = Multiline-String[source]#

Show Value

"""
This Public Utility Data Liberation (PUDL) project is a collection of tools
that allow programmatic access to and manipulation of many public data sets
related to electric utilities in the United States. These data sets are
often collected by state and federal agencies, but are publicized in ways
that are not well standardized, or intended for interoperability. PUDL
seeks to allow more transparent and useful access to this important public
data, with the goal of enabling climate advocates, academic researchers, and
data journalists to better understand the electricity system and its impacts
on climate.
"""

pudl.__projecturl__ = 'https://catalyst.coop/pudl/'[source]#

pudl.__downloadurl__ = 'https://github.com/catalyst-cooperative/pudl/'[source]#