pyproject.toml

[build-system]
requires = [
    "setuptools>=45",
    "setuptools_scm[toml]>=7.0",
]
build-backend = "setuptools.build_meta"

[project]
name = "scitacean"
description = "High-level interface for SciCat"
license = { "file" = "LICENSE" }
readme = "README.md"
keywords = ["scicat"]
classifiers = [
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: BSD License",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Topic :: Scientific/Engineering",
    "Typing :: Typed",
]
requires-python = ">=3.8"
dependencies = [
    "email-validator",
    "pydantic >= 1.9",
    "python-dateutil",
    "requests",
]
dynamic = ["version"]

[project.urls]
    "Documentation" = "https://scicatproject.github.io/scitacean"
    "Bug Tracker" = "https://github.com/SciCatProject/scitacean/issues"
    "Source" = "https://github.com/SciCatProject/scitacean"

[project.optional-dependencies]
ssh = ["fabric"]

[tool.setuptools_scm]

[tool.pytest.ini_options]
minversion = "7.0"
testpaths = "tests"
addopts = """
--strict-config
--strict-markers
-ra
-v
--hypothesis-profile=scitacean
"""
filterwarnings = [
    "error",
    # Many tests don't set a checksum, so File raises this warning.
    "ignore:Cannot check if local file:UserWarning",
    # From fabric / invoke
    "ignore:_SixMetaPathImporter:ImportWarning",
    "ignore:the imp module is deprecated in favour of importlib:DeprecationWarning",
]

[tool.mypy]
mypy_path = "src"
exclude = ["venv"]
ignore_missing_imports = true
enable_error_code = [
    "ignore-without-code",
    "redundant-expr",
    "truthy-bool",
]
strict = true
show_error_codes = true
warn_unreachable = true

[tool.ruff]
line-length = 88
select = ["B", "D", "E", "F", "I", "S", "T20", "PGH", "FBT003", "RUF100"]
ignore = ["B905",  # `zip()` without an explicit `strict=` parameter
          "S324",  # insecure hsh function; we don't use hashing for security
          "E741", "E742", "E743",  # do not use names ‘l’, ‘O’, or ‘I’; they are not a problem with a proper font
          "D100", "D101", "D102", "D103", "D104", "D105",  # TODO remove D10* once everything has docstrings
          ]
extend-exclude = [".*","__pycache__","build","dist","venv"]
fixable = ["I001"]

[tool.ruff.per-file-ignores]
"tests/*" = ["S101"]  # asserts are fine in tests

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

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