pyproject.toml

[project]
name = "stcal"
description = "STScI tools and algorithms used in calibration pipelines"
readme = "README.md"
requires-python = ">=3.10,<3.13"
authors = [
    { name = "STScI", email = "help@stsci.edu" },
]
classifiers = [
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: Astronomy",
    "License :: OSI Approved :: BSD License",
    "Programming Language :: Python :: 3",
]
dependencies = [
    "astropy >=5.0.4",
    "drizzle>=1.15.0",
    "scipy >=1.7.2",
    "scikit-image>=0.19",
    "numpy >=1.21.2",
    "opencv-python-headless >=4.6.0.66",
    "asdf >=2.15.0",
    "gwcs >= 0.18.1",
    "tweakwcs >=0.8.8",
    "requests >=2.22",
]
dynamic = [
    "version",
]

[project.license]
file = "LICENSE"

[project.optional-dependencies]
docs = [
    "numpydoc",
    "packaging >=17",
    "sphinx",
    "sphinx-asdf",
    "sphinx-astropy",
    "sphinx-rtd-theme",
    "tomli; python_version <=\"3.11\"",
]
test = [
    "psutil",
    "pytest >=6",
    "pytest-cov",
    "pytest-doctestplus",
]

[project.urls]
repository = "https://github.com/spacetelescope/stcal"
tracker = "https://github.com/spacetelescope/stcal/issues"

[build-system]
requires = [
    "setuptools >=61",
    "setuptools_scm[toml] >=3.4",
    "Cython >=0.29.21",
    "numpy >=2.0.0",
]
build-backend = "setuptools.build_meta"

[tool.setuptools_scm]
write_to = "src/stcal/_version.py"

[tool.setuptools]
zip-safe = true

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

[tool.pytest.ini_options]
minversion = 6
log_cli_level = "INFO"
xfail_strict = true
doctest_plus = true
doctest_rst = true
text_file_format = "rst"
addopts = [
    "--color=yes",
    "--doctest-rst",
    "-ra",
    "--strict-config",
    "--strict-markers",
]
testpaths = [
    "tests",
    "src/stcal",
    "docs",
]
norecursedirs = [
    "benchmarks",
    ".asv",
    ".eggs",
    ".tox",
    "build",
    "venv",
]
filterwarnings = [
    "error::ResourceWarning",
    # Files left open by tests can trigger ResourceWarnings during test
    # teardown which otherwise would be converted back into a warning
    # by pytest. Turn these PytestUnraisableExceptionWarnings back
    # into errors
    "error::pytest.PytestUnraisableExceptionWarning",
]
markers = [
    "soctests",
]

[tool.ruff]
line-length = 110
src = [
    "src",
    "tests",
    "docs",
]

[tool.ruff.lint]
select = [
    #"F",      # Pyflakes (part of default flake8)
    #"W", "E", # pycodestyle (part of default flake8)
    #"I",      # isort (import sorting)
    # "N",      # pep8-naming
    #"D",      # pydocstyle (docstring style guide)
    #"UP",     # pyupgrade (upgrade code to modern python)
    "YTT",    # flake8-2020 (system version info)
    "ANN",    # flake8-annotations (best practices for type annotations)
    #"S",      # flake8-bandit (security checks)
    "BLE",    # flake8-blind-except (prevent blind except statements)
    #"B",      # flake8-bugbear (prevent common gotcha bugs)
    "A",      # flake8-builtins (prevent shadowing of builtins)
    "C4",     # flake8-comprehensions (best practices for comprehensions)
    "T10",    # flake8-debugger (prevent debugger statements in code)
    #"EM",     # flake8-errormessages (best practices for error messages)
    "FA",     # flake8-future-annotations (correct usage future annotations)
    "ISC",    # flake8-implicit-str-concat (prevent implicit string concat)
    "ICN",    # flake8-import-conventions (enforce import conventions)
    #"G",      # flake8-logging-format (best practices for logging)
    "INP",    # flake8-no-pep420 (prevent use of PEP420, i.e. implicit name spaces)
    #"PIE",    # flake8-pie (misc suggested improvement linting)
    # "T20",    # flake8-print (prevent print statements in code)
    #"PT",     # flake8-pytest-style (best practices for pytest)
    #"Q",      # flake8-quotes (best practices for quotes)
    "RSE",    # flake8-raise (best practices for raising exceptions)
    #"RET",    # flake8-return (best practices for return statements)
    #"SLF",    # flake8-self (prevent private member access)
    "SLOT",   # flake8-slots (require __slots__ for immutable classes)
    #"SIM",    # flake8-simplify (suggest simplifications to code where possible)
    "TID",    # flake8-tidy-imports (prevent banned api and best import practices)
    "TCH",    # flake8-type-checking (move type checking imports into type checking blocks)
    "INT",    # flake8-gettext (when to use printf style strings)
    # "ARG",    # flake8-unused-arguments (prevent unused arguments)
    #"PTH",    # flake8-use-pathlib (prefer pathlib over os.path)
    # "ERA",    # eradicate (remove commented out code)
    "PGH",    # pygrep (simple grep checks)
    #"PL",     # pylint (general linting, flake8 alternative)
    #"TRY",    # tryceratops (linting for try/except blocks)
    "FLY",    # flynt (f-string conversion where possible)
    #"NPY",    # NumPy-specific checks (recommendations from NumPy)
    #"PERF",   # Perflint (performance linting)
    "LOG",
    #"RUF",    # ruff specific checks
]
ignore = [
    "ISC001", # interferes with formatter
    "PLR0912", # Too many branches
    "PLR0913", # Too many arguments
    "PLR0915", # Too many statements
    "PLR2004", # Magic value used in comparison
    "ANN101", # Missing type annotation for self in method
    "ANN102", # Missing type annotation for cls in classmethod

    # Pydocstyle (to fix over time
    "D100", # Undocumented public module
    "D101", # Undocumented public class
    "D102", # Undocumented public method
    "D103", # Undocumented public function
    "D104", # Undocumented public package
    "D205", # 1 blank line required between summary line and description
    "D401", # First line of docstring should be in imperative mood
    "D404", # First word of docstring should not be This
]
exclude = [
    "docs",
    "build",
    "dist",
    ".tox",
    ".eggs",
]

[tool.ruff.lint.extend-per-file-ignores]
"tests/*.py" = [
    "S101",
    "D",
]

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

[tool.ruff.lint.flake8-annotations]
ignore-fully-untyped = true  # Turn of annotation checking for fully untyped code

[tool.mypy]
python_version = "3.12"
warn_return_any = true
warn_unused_configs = true

[[tool.mypy.overrides]]
module = [
    "astropy.*",
    "gwcs.*",
    "tweakwcs.*",
    "stdatamodels.*",
    "asdf.*",
    "scipy.*",
    "drizzle.*",
    # don't complain about the installed c parts of this library
    "stcal.ramp_fitting.ols_cas22._fit",
    "stcal.ramp_fitting.ols_cas22._jump",
    "stcal.ramp_fitting.slope_fitter",
]
ignore_missing_imports = true

[tool.cython-lint]
max-line-length = 110

[tool.isort]
profile = "black"
filter_files = true
line_length = 110

[tool.codespell]
skip = "*.pdf,*.fits,*.asdf,.tox,build,./tags,.git,docs/_build"

[tool.cibuildwheel.macos]
archs = [
    "x86_64",
    "arm64",
]

[tool.cibuildwheel.linux]
archs = [
    "auto",
    "aarch64",
]

[tool.towncrier]
filename = "CHANGES.rst"
directory = "changes"
package = "stcal"
title_format = "{version} ({project_date})"
ignore = [".gitkeep"]
wrap = true
issue_format = "`#{issue} <https://github.com/spacetelescope/stcal/issues/{issue}>`_"

[tool.towncrier.fragment.apichange]
name = "Changes to API"

[tool.towncrier.fragment.bugfix]
name = "Bug Fixes"

[tool.towncrier.fragment.general]
name = "General"