pyproject.toml

[project]
name = "vIQA"
dynamic = ["version"]
description = "A Python package for volumetric image quality assessment."
authors = [
    { name = "Lukas Behammer", email = "lukas.behammer@fh-wels.at" },
]
readme = "README.md"
requires-python = ">=3.11"
keywords = [
    "IQA",
    "image quality assessment",
    "volumetric data",
    "image comparison",
    "CT",
    "computed tomography",
]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Topic :: Scientific/Engineering :: Image Processing",
    "License :: OSI Approved :: BSD License",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: C",
    "Programming Language :: C++",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: Unix",
]
#license = { file = "LICENSE.txt" }
license = { text = "BSD-3-Clause" }
dependencies = [
    "scipy >=1.10.0",
    "numpy <2.0.0, >=1.24.0",
    "torch >=1.13.0",
    "piq >= 0.8.0",
    "scikit-image >= 0.19.0",
    "nibabel >=5.0.0",
    "matplotlib >=3.5.0",
    "tqdm >=4.65.0",
]

[project.optional-dependencies]
book = [
    "jupyter",
    "ipywidgets",
]

tests = [
    "pytest",
    "pytest-cov",
    "pytest-doctestplus",
    "tox",
]
lint = [
    "mypy",
    "ruff",
    "pre-commit",
]
docs = [
    "sphinx",
    "furo",
    "sphinxcontrib-email",
    "sphinx_copybutton",
    "sphinx_github_changelog",
    "sphinx-autobuild",
    "sphinx-last-updated-by-git",
    "sphinx-hoverxref",
    "viqa[tests]",
]
dev = [
    "viqa[lint, docs]",
    "meson-python>=0.16.0",
    "build",
    "python-semantic-release",
    "cibuildwheel",
]

[project.urls]
Repository = "https://github.com/3dct/vIQA"
#Homepage
Documentation = "https://3dct.github.io/vIQA/"
Tracker = "https://github.com/3dct/vIQA/issues"
Download = "https://pypi.org/project/vIQA/#files"

[build-system]
requires = ["meson-python>=0.16.0", "numpy<2.0.0"]
build-backend = "mesonpy"

######################################################################
# Ruff
[tool.ruff]
extend-include = ["*.ipynb"]
extend-exclude = [
    ".git",
    "data",
    "docs",
    "build",
    "dist",
    "_private_tests",
    "tests",
]
target-version = "py311"

[tool.ruff.lint]
preview = true
select = [
    "ARG",
    "B",
    "C4",
    "D",
    "E",
    "F",
    "I",
    "N",
    "W",
    "C901",
]
ignore = [
    "D205",
    "D301",
    "B028",
    "E203",
    "C901", # temporarily disable complexity TODO: rewrite functions
]

[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["F403", "F405"]
"*.ipynb" = ["E501"]
"gsm.py" = ["F403", "F405"]
"kernels.py" = ["D103"]
"tools/generate_requirements.py" = ["D103"]

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

[tool.ruff.lint.isort]
known-first-party = ["src/vIQA"]

[tool.ruff.format]
exclude = ["*.ipynb"]

######################################################################
# MyPy
[tool.mypy]
exclude = [
    "tests",
    "docs",
    "build",
    "dist",
    "data",
]
strict = false
pretty = true

[[tool.mypy.overrides]]
module = [
    "scipy",
    "scipy.io",
    "scipy.ndimage",
    "scipy.fft",
    "scipy.stats",
    "piq",
    "tqdm",
    "tqdm.autonotebook",
    "ipywidgets",
    "IPython.display",
]
ignore_missing_imports = true

######################################################################
# PyTest
[tool.pytest.ini_options]
addopts = "--doctest-plus --doctest-continue-on-failure --cov=viqa --cov-append --cov-report html --import-mode=importlib"

######################################################################
# Coverage
[tool.coverage.run]
omit = [
    "src/viqa/_private_tests/*",
    "src/viqa/tests/*",
    "*/sphinxext/*",
    "*/tmp/tmp*.py",
    "docs/*",
]

######################################################################
# cibuildwheel
[tool.cibuildwheel]
build = [
    "cp311-manylinux_x86_64",
    "cp312-manylinux_x86_64",
#    "cp313-manylinux_x86_64",
    "cp311-musllinux_x86_64",
    "cp312-musllinux_x86_64",
#    "cp313-musllinux_x86_64",
    "cp311-win_*64",
    "cp312-win_*64",
#    "cp313-win_*64",
    "cp311-macosx*",
    "cp312-macosx*",
#    "cp313-macosx_x86_64",
#    "cp313-macosx_arm64",

]
manylinux-x86_64-image = "manylinux_2_28"

[[tool.cibuildwheel.overrides]]
select = "*-manylinux_x86_64"
before-all = [
    "env",
    "dnf install gcc-toolset-13 -y",
    "source /opt/rh/gcc-toolset-13/enable",
]
environment = { DEVTOOLSET_ROOTPATH="/opt/rh/gcc-toolset-13/root", PATH="/opt/rh/gcc-toolset-13/root/usr/bin:$PATH", LD_LIBRARY_PATH="/opt/rh/gcc-toolset-13/root/usr/lib64:/opt/rh/gcc-toolset-13/root/usr/lib:/opt/rh/gcc-toolset-13/root/usr/lib64/dyninst:/opt/rh/gcc-toolset-13/root/usr/lib/dyninst" }

[tool.cibuildwheel.windows.config-settings]
setup-args = "--vsenv"

[tool.cibuildwheel.macos]
archs = ["x86_64", "arm64"]
environment = { MACOSX_DEPLOYMENT_TARGET = "13.3" }

######################################################################
# Semantic Release
[tool.semantic_release]
commit_parser = "angular"
logging_use_named_masks = true
allow_zero_version = true
tag_format = "v{version}"
version_variables = ["./src/viqa/__init__.py:__version__"]
commit_message = "chore(release): {version}\n\nAutomatically generated by python-semantic-release"

[tool.semantic_release.changelog]
template_dir = "./templates"
changelog_file = "CHANGELOG.md"
exclude_commit_patterns = [
    ".*\\n\\nAutomatically generated by python-semantic-release",
    "chore: pre-commit autoupdate\n\nAutomatically generated by pre-commit.ci",
    "chore(?:\\([^)]*?\\))?: .+",
    "ci(?:\\([^)]*?\\))?: .+",
    "refactor(?:\\([^)]*?\\))?: .+",
    "style(?:\\([^)]*?\\))?: .+",
    "test(?:\\([^)]*?\\))?: .+",
    "build\\((?!deps\\): .+)",
    "book(?:\\([^)]*?\\))?: .+",
    "Merged? .*",
    "Initial Commit.*",
    "Create.*",
]

[tool.semantic_release.commit_parser_options]
allowed_types = [
    "build", "chore", "ci", "docs", "feat", "fix",
    "perf", "style", "refactor", "test", "book",
]
minor_types = ["feat"]
patch_types = ["fix", "perf"]