pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = [
    "setuptools>=66,<69",
    "setuptools_scm[toml]>=3.5.0",
    "wheel",
]

[project]
name = "catalystcoop.pudl"
description = "An open data processing pipeline for US energy data"
readme = {file = "README.rst", content-type = "text/x-rst"}
authors = [
    {name = "Catalyst Cooperative", email = "pudl@catalyst.coop"}
]
requires-python = ">=3.11,<3.12"
dynamic = ["version"]
license = {file = "LICENSE.txt"}
dependencies = [
    "addfips>=0.4,<0.5",
    "alembic>=1.10.3,<1.12",
    "catalystcoop.dbfread>=3.0,<3.1",
    "catalystcoop.ferc-xbrl-extractor==0.8.3",
    "coloredlogs>=14.0,<15.1",  # Dagster requires 14.0
    "dagster-webserver>=1.4,<1.5",  # 1.2.2 is first version to support Python 3.11
    "dagster>=1.4,<1.5",  # 1.2.2 is first version to support Python 3.11
    "dask>=2021.8,<2023.8.2",
    "datapackage>=1.11,<1.16",  # Transition datastore to use frictionless.
    "fsspec>=2021.7,<2023.6.1",  # For caching datastore on GCS
    "gcsfs>=2021.7,<2023.6.1",  # For caching datastore on GCS
    "geopandas>=0.13,<0.14",
    "grpcio<1.56.0",
    "jinja2>=2,<3.2",
    "matplotlib>=3.3,<3.8",  # Should make this optional with a "viz" extras
    "networkx>=2.2,<3.2",
    "pandas[parquet,excel,fss,gcp,compression]>=2.0,<2.1",
    "numpy>=1.18.5,!=1.23.0,<1.26",
    "pyarrow>=5,<12.1",
    "pydantic[email]>=1.7,<2",
    "python-dotenv>=0.21,<1.1",
    "pyyaml>=5,<6.1",
    "recordlinkage>=0.16,<0.17",
    "scikit-learn>=1.0,<1.4",
    "scipy>=1.6,<1.12",
    "Shapely>=2.0,<2.1",
    "sqlalchemy>=1.4,<2",
    "timezonefinder>=5,<6.3",
    "xlsxwriter>=3,<3.2",
]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Environment :: Console",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python",
    "Topic :: Scientific/Engineering",
]
keywords = [
    "analysis",
    "climate change",
    "coal",
    "data",
    "economics",
    "eia 860",
    "eia 861",
    "eia 923",
    "electricity",
    "emissions",
    "energy",
    "epa ampd",
    "epa cems",
    "ferc form 1",
    "ferc form 2",
    "ferc form 6",
    "ferc form 60",
    "ferc form 714",
    "finance",
    "fossil fuel",
    "natural gas",
    "oil",
    "policy",
    "utility",
]

[project.scripts]
metadata_to_rst = "pudl.convert.metadata_to_rst:main"
epacems_to_parquet = "pudl.convert.epacems_to_parquet:main"
ferc_to_sqlite = "pudl.ferc_to_sqlite.cli:main"
datasette_metadata_to_yml = "pudl.convert.datasette_metadata_to_yml:main"
pudl_datastore = "pudl.workspace.datastore:main"
pudl_etl = "pudl.cli.etl:main"
pudl_setup = "pudl.workspace.setup_cli:main"
state_demand = "pudl.analysis.state_demand:main"
pudl_check_fks = "pudl.etl.check_foreign_keys:main"
# pudl_territories currently blows up memory usage to 100+ GB.
# See https://github.com/catalyst-cooperative/pudl/issues/1174
# pudl_territories = "pudl.analysis.service_territory:main"

[project.urls]
"Homepage" = "https://catalyst.coop/pudl/"
"Source" = "https://github.com/catalyst-cooperative/pudl"
"Documentation" = "https://catalystcoop-pudl.readthedocs.io"
"Release Notes" = "https://catalystcoop-pudl.readthedocs.io/en/latest/release_notes.html"
"Issue Tracker" = "https://github.com/catalyst-cooperative/pudl/issues"
"Support" = "https://github.com/catalyst-cooperative/pudl/discussions"
"Funding" = "https://catalyst.coop/support-the-pudl-project/"

[project.optional-dependencies]
dev = [
    "black>=22.0,<23.8",
    "build>=0.10,<0.11",
    "ipdb>=0.13,<0.14",
    "isort>=5.0,<5.13",
    "jedi>=0.18,<0.20",
    "lxml>=4.6,<4.10",
    "tox>=4,<4.11",
    "twine>=3.3,<4.1",
]
doc = [
    "doc8>=0.9,<1.2",
    "furo>=2022.4.7",
    "sphinx-autoapi>=1.8,<2.2",
    "sphinx-issues>=1.2,<3.1",
    "sphinx-reredirects",
    "sphinx>=4,!=5.1.0,<7.3",
    "sphinxcontrib_bibtex>=2.4,<2.6",
]
test = [
    "bandit>=1.6,<1.8",
    "coverage>=5.3,<7.4",
    "doc8>=0.9,<1.2",
    "flake8-builtins>=1.5,<2.2",
    "flake8-docstrings>=1.5,<1.8",
    "flake8-rst-docstrings>=0.2,<0.4",
    "flake8-use-fstring>=1.0,<1.5",
    "flake8>=4.0,<6.2",
    "jupyter",
    "mccabe>=0.6,<0.8",
    "nbconvert>=7,<8",
    "nbformat>=5,<6",
    "pep8-naming>=0.12,<0.14",
    "pre-commit>=2.9,<3.4",
    "pydocstyle>=5.1,<6.4",
    "pytest-console-scripts>=1.1,<1.5",
    "pytest-cov>=2.10,<4.2",
    "pytest-mock>=3.0,<3.12",
    "pytest>=6.2,<7.5",
    "responses>=0.14,<0.24",
    "rstcheck[sphinx]>=5.0,<6.2",
    "tox>=4.0,<4.11",
]
datasette = [
    "datasette>=0.60,<0.65",
]

[tool.setuptools]
include-package-data = true

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools_scm]

[tool.black]
line-length = 88
target-version = ["py311"]
include = "\\.pyi?$"

[tool.isort]
profile = "black"
known_first_party = "pudl"