pyproject.toml

[build-system]
requires = ["setuptools>=68.0.0", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "glazing"
version = "0.2.2"
description = "Unified data models and interfaces for syntactic and semantic frame ontologies"
readme = "README.md"
requires-python = ">=3.13"
license = "MIT"
authors = [
    {name = "Aaron Steven White", email = "aaron.white@rochester.edu"}
]
keywords = ["nlp", "linguistics", "framenet", "propbank", "verbnet", "wordnet", "semantics", "lexicon"]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Text Processing :: Linguistic",
    "Typing :: Typed",
]

dependencies = [
    "pydantic>=2.5.0",
    "typing-extensions>=4.9.0",
    "python-dateutil>=2.8.2",
    "lxml>=5.0.0",
    "click>=8.0.0",
    "requests>=2.25.0",
    "tqdm>=4.60.0",
    "rich>=13.0.0",
    "python-Levenshtein>=0.20.0",
]

[project.optional-dependencies]
dev = [
    "ruff>=0.1.9",
    "mypy>=1.8.0",
    "pytest>=7.4.3",
    "pytest-cov>=4.1.0",
    "pytest-asyncio>=0.21.1",
    "pre-commit>=3.6.0",
    "lxml-stubs>=0.5.0",
    "types-requests>=2.25.0",
    "types-tqdm>=4.60.0",
    "types-click>=7.1.0",
]
docs = [
    "mkdocs>=1.5.3",
    "mkdocs-material>=9.5.3",
    "mkdocstrings[python]>=0.24.0",
    "griffe-pydantic>=1.0.0",
    "pymdown-extensions>=10.7",
]

[project.scripts]
glazing = "glazing.cli:cli"

[project.urls]
"Homepage" = "https://github.com/factslab/glazing"
"Bug Reports" = "https://github.com/factslab/glazing/issues"
"Source" = "https://github.com/factslab/glazing"
"Documentation" = "https://glazing.readthedocs.io"

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

[tool.ruff]
line-length = 100
target-version = "py312"
src = ["src", "tests"]

[tool.ruff.lint]
select = [
    "E",    # pycodestyle errors
    "W",    # pycodestyle warnings
    "F",    # pyflakes
    "I",    # isort
    "B",    # flake8-bugbear
    "C90",  # mccabe
    "N",    # pep8-naming
    "UP",   # pyupgrade
    "YTT",  # flake8-2020
    "ANN",  # flake8-annotations
    "S",    # flake8-bandit
    "BLE",  # flake8-blind-except
    "FBT",  # flake8-boolean-trap
    "A",    # flake8-builtins
    "C4",   # flake8-comprehensions
    "DTZ",  # flake8-datetimez
    "EM",   # flake8-errmsg
    "ISC",  # flake8-implicit-str-concat
    "ICN",  # flake8-import-conventions
    "G",    # flake8-logging-format
    "PIE",  # flake8-pie
    "PT",   # flake8-pytest-style
    "Q",    # flake8-quotes
    "RET",  # flake8-return
    "SIM",  # flake8-simplify
    "TID",  # flake8-tidy-imports
    "ARG",  # flake8-unused-arguments
    "PTH",  # flake8-use-pathlib
    "ERA",  # eradicate
    "PD",   # pandas-vet
    "PGH",  # pygrep-hooks
    "PL",   # pylint
    "TRY",  # tryceratops
    "RUF",  # ruff-specific rules
]
ignore = [
    "PLR2004", # Magic value used in comparison
    "TRY003",  # Avoid specifying long messages outside the exception class
    "EM101",   # Exception must not use a string literal
    "FBT001",  # Boolean-typed positional argument in function definition
    "FBT002",  # Boolean default positional argument in function definition
]

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["S101", "S320", "ANN", "ARG", "PT011", "FBT003", "PTH123"]
"tests/conftest.py" = ["E501"]
"tests/test_utils/test_xml_parser.py" = ["E501"]
"tests/test_verbnet/test_converter.py" = ["E501", "S314"]
"tests/test_verbnet/test_inheritance.py" = ["E501"]
"tests/test_wordnet/test_converter.py" = ["E501"]
"tests/test_integration/test_converter_loader_roundtrip.py" = ["E501"]
"tests/test_cli/test_download.py" = ["E501", "EM102"]
"tests/test_downloader.py" = ["E501", "F841"]
"tests/test_verbnet/test_downloader.py" = ["E501", "F841"]
"tests/test_framenet/test_downloader.py" = ["E501", "F841"]
"tests/test_propbank/test_downloader.py" = ["E501", "F841", "PLC0415"]
"tests/test_wordnet/test_downloader.py" = ["E501", "F841", "PLC0415"]
"src/glazing/utils/cache.py" = ["ANN002", "ANN003", "PLW0603"]
"src/glazing/utils/xml_parser.py" = ["S320"]
"src/glazing/wordnet/converter.py" = ["C901", "PLR0912", "PLR0915"]
"src/glazing/wordnet/loader.py" = ["C901", "PLR0912"]
"src/glazing/verbnet/converter.py" = ["C901", "S320", "PLR0912"]
"src/glazing/framenet/converter.py" = ["S320", "C901", "PLR0912", "PLR0915"]
"src/glazing/propbank/converter.py" = ["S320"]

[tool.ruff.lint.pydocstyle]
convention = "numpy"

[tool.mypy]
python_version = "3.13"
strict = true
warn_return_any = true
warn_unused_configs = true
disallow_untyped_defs = true
disallow_any_unimported = true
no_implicit_optional = true
check_untyped_defs = true
warn_redundant_casts = true
warn_unused_ignores = true
warn_no_return = true
follow_imports = "normal"
namespace_packages = true
show_error_codes = true
pretty = true

[[tool.mypy.overrides]]
module = "tests.*"
ignore_errors = true

[tool.pytest.ini_options]
minversion = "7.0"
testpaths = ["tests"]
python_files = ["test_*.py", "*_test.py"]
python_classes = ["Test*"]
python_functions = ["test_*"]
addopts = [
    "--strict-markers",
    "--tb=short",
    "--cov=glazing",
    "--cov-report=term-missing",
    "--cov-report=html",
    "--cov-report=xml",
]

[tool.coverage.run]
source = ["src/glazing"]
omit = ["*/tests/*", "*/test_*.py"]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "def __repr__",
    "if __name__ == .__main__.:",
    "raise AssertionError",
    "raise NotImplementedError",
    "if TYPE_CHECKING:",
]