pyproject.toml

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

[project]
name = "cc-plugin-sgrid"
description = "SGRID plugin for the IOOS Compliance Checker Plugin"
readme = "README.md"
license = { text = "Apache-2.0" }
maintainers = [
  { name = "Kyle Wilcox" },
  { name = "Filipe Fernandes" },
]
requires-python = ">=3.9"
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: Developers",
  "Intended Audience :: Science/Research",
  "License :: OSI Approved :: Apache Software License",
  "Operating System :: MacOS :: MacOS X",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX :: Linux",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3 :: Only",
  "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",
  "Topic :: Scientific/Engineering",
]
dynamic = [
  "dependencies",
  "version",
]

urls.documentation = "https://ioos.github.io/cc-plugin-sgrid"
urls.homepage = "https://compliance.ioos.us/index.html"
urls.repository = "https://github.com/ioos/cc-plugin-sgrid"

entry-points."compliance_checker.suites"."sgrid-1.0.0" = "cc_plugin_sgrid.checker_100:SgridChecker100"

[tool.setuptools]
packages = [
  "cc_plugin_sgrid",
]
license-files = [
  "LICENSE",
]
zip-safe = false
include-package-data = true

[tool.setuptools.dynamic]
dependencies = { file = [
  "requirements.txt",
] }
readme = { file = "README.md", content-type = "text/markdown" }

[tool.setuptools_scm]
write_to = "cc_plugin_sgrid/_version.py"
write_to_template = "__version__ = '{version}'"
tag_regex = "^(?P<prefix>v)?(?P<version>[^\\+]+)(?P<suffix>.*)?$"

[tool.ruff]
target-version = "py39"
line-length = 110

lint.select = [ "ALL" ]

lint.ignore = [
  "ANN",     # Missing type annotation
  "D107",    # Missing docstring in `__init__`
  "ERA001",  # Found commented-out code
  "N801",    # Class name should use CapWords convention
  "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
  "TRY301",  # Abstract `raise` to an inner function
]

lint.extend-per-file-ignores."cc_plugin_sgrid/tests/*.py" = [
  "ANN001", # Missing type annotation for function argument
  "ANN201", # Missing return type annotation for public function
  "ANN202", # Missing return type annotation for private function
  "D100",   # Missing docstring in public module
  "D101",   #  Missing docstring in public class
  "D102",   # Missing docstring in public method
  "D104",   # Missing docstring in public package
  "D105",   # Missing docstring in magic method
  "D107",   # Missing docstring in `__init__`
  "D205",   # 1 blank line required between summary line and description
  "INP001", # File is part of an implicit namespace package
  "PD901",  # Avoid using the generic variable name `df` for DataFrames
  "S101",   # Use of assert detected
  "SLF001", # Private member accessed
]

[tool.pytest.ini_options]
filterwarnings = [
  # We try to use strings instead od floats in puporse in the tests.
  "ignore::UserWarning",
]

[tool.interrogate]
fail-under = 79
exclude = [ "docs", "build" ]
verbose = 0
quiet = false
color = true
omit-covered-files = false