pyproject.toml

[project]
name = "external-resources-io"
version = "0.3.3"
requires-python = ">=3.11"
description = "Util classes for AppSRE External Resources system"
license = { text = "Apache 2.0" }
readme = "README.md"
authors = [{ name = "Jordi Piriz", email = "jpiriz@redhat.com" }]
dependencies = ["pydantic >=2.10.0"]

[project.urls]
homepage = "https://github.com/app-sre/external-resources-io"
repository = "https://github.com/app-sre/external-resources-io"
documentation = "https://github.com/app-sre/external-resources-io"

[dependency-groups]
dev = [
    # dev dependencies
    "mypy ~=1.13",
    "pytest ~=8.3",
    "pytest-cov ~=6.0",
    "ruff ~=0.8",
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build.targets.sdist]
only-include = ["external_resources_io"]

[tool.hatch.build.targets.wheel]
only-include = ["external_resources_io"]

# Ruff configuration
[tool.ruff]
line-length = 88
src = [""]
extend-exclude = [
    # exclude some common cache and tmp directories
    ".local",
    ".cache",
    "tmp",
]
fix = true

[tool.ruff.lint]
preview = true
select = ["ALL"]
ignore = [
    "CPY",     # Missing copyright header
    "D100",    # Missing docstring in public module
    "D101",    # Missing docstring in public class
    "D102",    # Missing docstring in public method
    "D103",    # Missing docstring in public function
    "D104",    # Missing docstring in public package
    "D105",    # Missing docstring in magic method
    "D107",    # Missing docstring in __init__
    "D203",    # 1 blank line required before class docstring
    "D211",    # No blank lines allowed before class docstring
    "D212",    # multi-line-summary-first-line
    "D213",    # multi-line-summary-second-line
    "D4",      # Doc string style
    "E501",    # Line too long
    "G004",    # Logging statement uses f-string
    "PLR0904", # Too many public methods
    "PLR0913", # Too many arguments
    "PLR0917", # Too many positional arguments
    "S101",    # Use of assert detected. Pytest uses assert
    "S404",    # subprocess import
    "EM101",   # Exception must not use a string literal, assign to variable first
    "EM102",   # Exception must not use an f-string literal, assign to variable first
    "TRY003",  # Avoid specifying long messages outside the exception class
    "TRY300",  # try-consider-else
    # pydoclint
    "DOC",
    # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
    "W191",
    "E111",
    "E114",
    "E117",
    "D206",
    "D300",
    "Q",
    "COM812",
    "COM819",
    "ISC001",
]
[tool.ruff.format]
preview = true

[tool.ruff.lint.isort]
known-first-party = ["external_resources_io"]

# Mypy configuration
[tool.mypy]
files = ["external_resources_io", "tests"]
enable_error_code = ["truthy-bool", "redundant-expr"]
no_implicit_optional = true
check_untyped_defs = true
warn_unused_ignores = true
show_error_codes = true
disallow_untyped_defs = true
disallow_incomplete_defs = true

[tool.coverage.run]
branch = true
omit = ["*/tests/*"]

[tool.coverage.report]
fail_under = 30