pyproject.toml

[build-system]
requires = ["setuptools>=61.2", "setuptools_scm", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "cavendish-particle-tracks"
description = "A Napari plugin to perform a simple particle tracking analysis for the Cavendish Laboratory's Undergraduate Part II Particle Tracks experiment."
authors = [
    { name = "Sam Cunliffe", email = "s.cunliffe@ucl.ac.uk" },
    { name = "Paula Alvarez Cartelle", email = "palvarez@hep.phy.cam.ac.uk" },
    { name = "Joseph Garvey", email = "jmg237@cam.ac.uk" },
]
license = { text = "MIT" }
classifiers = [
    "Development Status :: 2 - Pre-Alpha",
    "Framework :: napari",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Scientific/Engineering :: Image Processing",
]
requires-python = ">=3.9"
dependencies = [
    "imagecodecs",              # for opening tiff images on macos
    "napari >= 0.5.2, < 0.6.0", # need >= 0.5.2 to be able to open as stack (https://github.com/napari/napari/issues/7165) and < 0.6.0 to hide layers controls
    "numpy",
    "dask-image",               # for image loading
]
dynamic = ["version"]

[project.readme]
file = "README.md"
content-type = "text/markdown"

[project.urls]
Homepage = "https://palvarezc.github.io/cavendish-particle-tracks/"
"Bug Tracker" = "https://github.com/samcunliffe/cavendish-particle-tracks/issues"
Documentation = "https://palvarezc.github.io/cavendish-particle-tracks/user-manual.html"
"Source Code" = "https://github.com/samcunliffe/cavendish-particle-tracks"
"User Support" = "https://github.com/samcunliffe/cavendish-particle-tracks/issues"

[project.entry-points."napari.manifest"]
cavendish-particle-tracks = "cavendish_particle_tracks:napari.yaml"

[project.optional-dependencies]
docs = [
    "sphinx",
    "sphinx-pyproject",    # (take project conf from pyproject.toml) https://sphinx-pyproject.readthedocs.io
    "pydata-sphinx-theme",
    "myst-parser",
    "pyqt5",
]
testing = [
    "tox",
    "pytest",      # https://docs.pytest.org/en/latest/contents.html
    "pytest-cov",  # https://pytest-cov.readthedocs.io/en/latest/
    "pytest-mock",
    "pytest-qt",   # https://pytest-qt.readthedocs.io/en/latest/
    "napari",
    "pyqt5",
]

[tool.setuptools]
include-package-data = true
package-dir = { "" = "src" }
# add your package requirements here
license-files = ["LICENSE"]

[tool.setuptools.packages.find]
where = ["src"]
namespaces = false

[tool.setuptools.package-data]
"*" = ["*.yaml"]

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

[tool.black]
line-length = 90
target-version = ['py39', 'py310', 'py311', 'py312']


[tool.ruff]
line-length = 90
target-version = "py39"
fix = true

[tool.ruff.lint]
select = [
    "E",
    "F",
    "W",   #flake8
    "UP",  # pyupgrade
    "I",   # isort
    "BLE", # flake8-blind-exception
    "B",   # flake8-bugbear
    "A",   # flake8-builtins
    "C4",  # flake8-comprehensions
    "ISC", # flake8-implicit-str-concat
    "G",   # flake8-logging-format
    "PIE", # flake8-pie
    "SIM", # flake8-simplify
]
ignore = [
    "E501",   # line too long. let black handle this
    "UP006",
    "UP007",  # type annotation. As using magicgui require runtime type annotation then we disable this.
    "SIM117", # flake8-simplify - some of merged with statements are not looking great with black, reanble after drop python 3.9
]

exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".mypy_cache",
    ".pants.d",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
    "*vendored*",
    "*_vendor*",
]


[tool.tox]
legacy_tox_ini = """

[tox]
envlist = py{39,310,311,312}-{linux,macos,windows}
isolated_build=true

[gh-actions]
python =
    3.9: py39
    3.10: py310
    3.11: py311
    3.12: py312

[gh-actions:env]
PLATFORM =
    ubuntu-latest: linux
    macos-latest: macos
    windows-latest: windows

[testenv]
platform =
    macos: darwin
    linux: linux
    windows: win32
passenv =
    CI
    GITHUB_ACTIONS
    DISPLAY
    XAUTHORITY
    NUMPY_EXPERIMENTAL_ARRAY_FUNCTION
    PYVISTA_OFF_SCREEN
extras =
    testing
commands = pytest -v --color=yes --cov=cavendish_particle_tracks --cov-report=xml
"""

[tool.sphinx-pyproject]
html_title = "Cavendish Particle Tracks Napari Plugin"
html_theme = "pydata_sphinx_theme"

extensions = [
    'sphinx.ext.todo',
    'sphinx.ext.viewcode',
    'sphinx.ext.autodoc',
    'myst_parser',
]

html_theme_options = { icon_links = [
    { name = "GitHub", url = "https://github.com/samcunliffe/cavendish-particle-tracks", icon = "fa-brands fa-github" },
] }

# remove the primary sidebar on all pages
# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#primary-sidebar-left
html_sidebars = { "**" = [] }