sensospot_tools/pyproject.toml

[build-system]
requires = ["flit_core>=3.2,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "sensospot_tools"
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.9"
dynamic = ["version", "description"]

authors = [
    {name = "Holger Frey", email = "frey@imtek.de"},
]

# see https://pypi.org/classifiers/
classifiers = [
    "Development Status :: 2 - Pre-Alpha",
    "Intended Audience :: Developers",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3 :: Only",
    "License :: Freely Distributable",
]

dependencies = [
    "pandas"
]

[project.urls]
Source = "https://git.cpi.imtek.uni-freiburg.de/holgi/sensospot_tools.git"

# [project.scripts]
# script_name = "sensospot_tools:function"

[project.optional-dependencies]
test = [
    "pytest >=4.0.0",
    "pytest-cov",
    "pytest-mock",
    "pytest-randomly",
    "tox",
]
dev = [
    "black",
    "keyring",
    "pre-commit",
    "ruff",
]
docs = [
    "mkdocs",
    "mkdocstrings[python]",
]


[tool.pytest.ini_options]
markers = [
    "functional: marks tests as functional (deselect with '-m \"not functional\"')",
]
addopts = [
    "--strict-markers",
]


[tool.black]
line-length = 79
target-version = ['py39', 'py310']
include = '\.pyi?$'
extend-exclude = '''
# A regex preceded with ^/ will apply only to files and directories
# in the root of the project.
^/.git
^/.tox
^/.venv
^/.build
^/.dist
'''


[tool.ruff]
select = ["ALL"]
ignore = [
    # ignored for now, should be activated in the future
    # docstrings 
    "D", 
    # flake8-annotations
    "ANN",
    # flake8-type-checking
    "TCH",

    # ignored, "black" will handle this
    # flake8-commas
    "COM", 

    # ignored, due to Windows / WSL2 setup
    # flake8-executable
    "EXE",
    
    # project specific ignores
    # flake8-import-conventions
    "ICN",
]
fixable = ["I"]
fix = true
line-length=79
target-version = "py38"

[tool.ruff.per-file-ignores]
# see https://github.com/charliermarsh/ruff
"tests/*" = ["FBT003", "INP001", "PLR2004", "S101"]

[tool.ruff.pydocstyle]
convention = "pep257"  # Accepts: "google", "numpy", or "pep257"