pyproject.toml

[build-system]
requires = ["setuptools>=42"]
build-backend = "setuptools.build_meta"

[project]
name = "hedvis"
version = "0.1.1"
description = "HED validation, summary, and analysis tools for annotating events and experimental metadata."
readme = "README.md"
authors = [
    { name = "VisLab" },
    { name = "Ian Callanan" },
    { name = "Kay Robbins", email = "Kay.Robbins@utsa.edu" },
]
maintainers = [
    { name = "HED Maintainers", email = "hed.maintainers@gmail.com" },
]
license = {text = "MIT"}
keywords = ["HED", "hierarchical event descriptors", "validation", "neuroscience", "BIDS", "events", "metadata", "annotation"]
classifiers = [
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Operating System :: OS Independent",
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "License :: OSI Approved :: MIT License",
]

requires-python = ">=3.10"

dependencies = [
    "hedtools>=0.9.0",
    "matplotlib>=3.9.0",
    "pandas>=2.2.3,<3.0.0",
    "numpy",
    "pillow>=11.2.1",
    "wordcloud>=1.9.4",
]

[project.urls]
"Homepage" = "https://www.hedtags.org/"
"Documentation" = "https://www.hedtags.org/hed-python"
"Repository" = "https://github.com/hed-standard/hed-vis"
"Bug Tracker" = "https://github.com/hed-standard/hed-vis/issues"
"Changelog" = "https://github.com/hed-standard/hed-vis/blob/main/CHANGELOG.md"
"HED Resources" = "https://www.hedtags.org/hed-resources"

[project.optional-dependencies]
dev = [
    "ruff>=0.8.0",
    "typos>=1.29.0",
    "mdformat>=0.7.0",
    "mdformat-myst>=0.1.5",
    "coverage>=7.0.0",
]
docs = [
    "sphinx>=7.1.0,<10.0",
    "furo>=2024.1.29",
    "sphinx-copybutton>=0.5.2",
    "myst-parser>=3.0.0",
    "sphinx-autodoc-typehints>=1.24.0",
    "linkify-it-py>=2.0.3",
]

[tool.setuptools.packages.find]
where = [""]
include = ["hedvis*"]
namespaces = false

[tool.setuptools.package-data]
hedvis = []

[tool.typos.files]
extend-exclude = [
    "*.pdf",
    "*.svg",
    "deprecated/",
    "venv*/",
    "*.tsv",
    "*.yaml",
    "*.yml",
    "*.json",
    "*.rdf",
    "*.jsonld",
    "tests/",
    "*.xml",
    "*.mediawiki",
    "*.omn",
    "*.toml",
]

[tool.typos.default.extend-words]
# Domain-specific terms and abbreviations that are not typos
te = "te"
parms = "parms"
assertIn = "assertIn"
covert = "covert"
hed = "hed"
recuse = "recuse"
disjointness = "disjointness"

[tool.typos.default.extend-identifiers]
# Misspelling in upstream wordcloud library's private API
_get_bolean_mask = "_get_bolean_mask"

[tool.ruff]
# Target Python 3.10+
target-version = "py310"
line-length = 120

# Exclude common directories
exclude = [
    ".git",
    ".venv",
    "venv",
    "__pycache__",
    "build",
    "dist",
    ".eggs",
    "*.egg-info",
    ".status",
    "status",
]

[tool.ruff.lint]
# Enable flake8-style checks plus additional rules
select = [
    "E",     # pycodestyle errors
    "W",     # pycodestyle warnings
    "F",     # pyflakes
    "N",     # pep8-naming
    "B",     # flake8-bugbear
    "C4",    # flake8-comprehensions
]

ignore = [
    "E501",   # Line too long (handled by formatter)
    "N802",   # Function name should be lowercase (many test methods use camelCase)
    "N803",   # Argument name should be lowercase (DataFrame df is common)
    "N806",   # Variable in function should be lowercase (common in scientific code)
    # Style rules that are too opinionated
    "SIM108", # if-else-block-instead-of-if-exp (ternary operator preference)
    "SIM105", # suppressible-exception (use contextlib.suppress)
    "SIM118", # in-dict-keys (x in dict vs x in dict.keys())
    "SIM102", # collapsible-if (nested if statements)
    "SIM103", # needless-bool (return bool vs if/else return True/False)
    "SIM110", # reimplemented-builtin (any/all reimplementation)
    "SIM101", # duplicate-isinstance-call
    # Python 3.10+ features
    "UP007",  # Use X | Y for Union types (requires 3.10+)
    "UP008",  # Use super() without parameters (we're okay with explicit)
    "UP031",  # Use format strings over %-formatting (legacy code compatibility)
    "UP028",  # yield in for loop
    "UP045",  # Use X | None for Optional (requires 3.10+)
]

# Allow unused imports in __init__.py files
[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F401"]

[tool.ruff.lint.mccabe]
# Maximum complexity (matching your flake8 setting)
max-complexity = 10

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

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