pyproject.toml

[project]
name = 'stpipe'
description = 'Framework for calibration pipeline software'
readme = 'README.md'
requires-python = '>=3.9'
license = { file = 'LICENSE' }
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 = [
    'asdf>=2.13',
    'crds>=7.4.1.3',
    'astropy>=5.0.4',
    'importlib_metadata>=4.11.4',
]
dynamic = ['version']

[project.optional-dependencies]
docs = [
    'numpydoc',
    'sphinx',
    'sphinx-automodapi',
    'sphinx-rtd-theme',
    'stsci-rtd-theme',
    'tomli; python_version <"3.11"',
]
test = [
    'pytest >=7.0.0',
    'pytest-doctestplus >=0.10.0',
]

[project.urls]
'repository' = 'https://github.com/spacetelescope/stpipe'
'tracker' = 'https://github.com/spacetelescope/stpipe/issues'

[project.entry-points]
'asdf.resource_mappings' = {stpipe = 'stpipe.integration:get_resource_mappings'}

[project.scripts]
stpipe = 'stpipe.cli.main:main'
strun = 'stpipe.cli.strun:main'

[build-system]
requires = [
    'setuptools >=61',
    'setuptools_scm[toml] >=3.4',
]
build-backend = 'setuptools.build_meta'

[tool.setuptools_scm]
write_to = "src/stpipe/_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 = [
    "--strict-config",
    "--strict-markers",
    "-ra",
    "--color=yes"
]
testpaths = [
    'tests',
]
filterwarnings = [
    "error::ResourceWarning",
]
markers = [
    "soctests",
]

[tool.ruff]
src = [
    "src",
    "tests",
    "docs",
    "setup.py",
]
line-length = 88
extend-exclude = [
    'docs',
    'scripts/strun',
]

[tool.ruff.lint]
extend-select = [
    'F',      # Pyflakes
    'W', 'E', # pycodestyle
    'I',      # isort
    'N',      # pep8-naming
    'UP',     # pyupgrade
    'S',      # flake8-bandit
    # 'BLE',    # flake8-blind-except
    'B',      # flake8-bugbear
    'A',       # flake8-builtins (prevent shadowing of builtins)
    'C4',      # flake8-comprehensions (best practices for comprehensions)
    'T10',     # flake8-debugger (prevent debugger statements in code)
    'ISC',     # flake8-implicit-str-concat (prevent implicit string concat)
    'ICN',     # flake8-import-conventions (enforce import conventions)
    'INP',     # flake8-no-pep420 (prevent use of PEP420, i.e. implicit name spaces)
    'G',       # flake8-logging-format (best practices for logging)
    '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)
    'TID',     # flake8-tidy-imports (prevent banned api and best import practices)
    '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)
    'FLY',     # flynt (f-string conversion where possible)
    'NPY',     # NumPy-specific checks (recommendations from NumPy)
    'PERF',    # Perflint (performance linting)
    'RUF',     # ruff specific checks
]
ignore = [
    "ISC001",  # conflicts with ruff formatter
]

[tool.ruff.lint.extend-per-file-ignores]
"tests/*.py" = ["S101", "S603", "S607", "INP001", "ARG001"]
"src/stpipe/tests/*.py" = ["S101"]
"src/stpipe/cli/*.py" = ["T201"]
"src/stpipe/cmdline.py" = ["T201"]


[tool.black]
line-length = 88
force-exclude = '''
^/(
  (
      \.eggs
    | \.git
    | \.pytest_cache
    | \.tox
  )/
)
'''

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


[tool.repo-review]
ignore = [
    "GH200",  # Use dependabot
    "PC140",  # add MyPy to pre-commit
    "PC901",  # custom pre-comit.ci message
    "MY100",  # Use MyPy
]