pyproject.toml

[project]
name = "brand_yml"
description = "Read brand yaml files, a unified way to store brand information."
readme = "pkg-py/README.md"
requires-python = ">=3.9"
dependencies = [
    "ruamel-yaml>=0.18.0",
    "pydantic>=2",
    "eval-type-backport>=0.2.0",
    "htmltools>=0.2.0"
]
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: MIT License",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
]
authors = [
  {name = "Garrick Aden-Buie", email = "garrick@posit.co"}
]
dynamic = ["version"]

[project.urls]
Homepage = "https://posit-dev.github.io/brand-yml/"
Documentation = "https://posit-dev.github.io/brand-yml/pkg/py/"
Repository = "https://github.com/posit-dev/brand-yml"
Issues = "https://github.com/posit-dev/brand-yml/issues/"
Changelog = "https://github.com/posit-dev/brand-yml/blob/main/pkg-py/CHANGELOG.md"

[project.optional-dependencies]
test = [
    "pyright>=1.1.251",
    "pytest>=8",
    "syrupy>=4",
]
docs = [
    "griffe>=1",
    "quartodoc>=0.7",
    # Quarto requires...
    "ipykernel",
    "nbclient",
    "nbformat",
    "pyyaml",
]

[tool.uv]
dev-dependencies = [
    "coverage>=7",
    "jsonschema>=4",
    "pre-commit-uv>=4.1.3",
    "ruff>=0.6.5",
    "tox-uv>=1",
]
upgrade-package = ["brand_yml"]

[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[tool.hatch.build]
skip-excluded-dirs = true

[tool.hatch.build.targets.wheel]
packages = ["pkg-py/src/brand_yml"]

[tool.hatch.build.targets.wheel.force-include]
"examples" = "brand_yml/examples"

[tool.hatch.build.targets.sdist]
include = ["/pkg-py/src/brand_yml", "/examples"]

[tool.hatch.version]
source = "vcs"
tag-pattern = "^py/(?:[\\w-]+-)?(?P<version>[vV]?\\d+(?:\\.\\d+){0,2}[^\\+]*)(?:\\+.*)?$"

[tool.hatch.build.hooks.vcs]
version-file = "pkg-py/src/brand_yml/__version.py"

[tool.pyright]
include = ["pkg-py"]
exclude = ["pkg-py/_dev", "pkg-py/.venv"]

[tool.coverage.paths]
source = [
  "pkg-py/src/brand_yml",
]

[tool.coverage.run]
branch = true
source = [
  "pkg-py/src/brand_yml",
]

[tool.coverage.report]
exclude_lines = [
  "pragma: no cover",
  "cover: for type checker",
  "raise NotImplementedError",
  "pass",
]

[tool.tox]
legacy_tox_ini = """
[tox]
env_list = type-py3{9,10,11,12}, py3{9,10,11,12}
isolated_build = True

[testenv]
package = wheel
wheel_build_env = .pkg
commands = pytest

[testenv:type]
deps =
  pyright
  pytest
  syrupy
commands = pyright
"""

[tool.ruff]
src = ["pkg-py"]
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "site-packages",
    "venv",
    "_dev",
]

line-length = 80
indent-width = 4

target-version = "py39"

[tool.ruff.lint]
select = ['E', 'F', 'W', 'A', 'PLC', 'PLE', 'PLW', 'I']
ignore = ["E501"]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
line-ending = "auto"
docstring-code-format = true
docstring-code-line-length = "dynamic"