pyproject.toml

[build-system]
requires = ["setuptools", "wheel", "setuptools-git-versioning"]
build-backend = "setuptools.build_meta"

[tool.setuptools-git-versioning]
enabled = true
template = "{tag}" # For tagged releases (e.g., v1.0.0 becomes 1.0.0)
dev_template = "{tag}.dev{ccount}" # For commits after a tag (e.g., 1.0.0.dev1)
# dev_template = "{tag}.dev{ccount}+{sha}"
dirty_template = "{tag}+dirty" # Simple dirty indicator, if you have untracked changes
# Filter out "v" prefix in final version number (e.g., 1.0.0 instead of v1.0.0)
tag_filter = '^v'

[tool.setuptools]
packages = ["console"]
package-dir = {"" = "src"}

[project]
name = "nexus-console"
dynamic = ["version"]
description = "MRI Nexus console application to run pulseq sequences on Spectrum-Instrumentation measurement cards."
authors = [
    {name="David Schote", email="david.schote@ptb.de"},
    {name="Berk Silemek"},
    {name="Thomas O'Reilly"}
]
readme = "README.md"
requires-python = ">=3.10,<3.14"
license = "GPL-3.0-or-later"
keywords = ["MRI, console, spectrum-instrumentation, acquisition, pulseq"]
classifiers = [
    "Programming Language :: Python",
    "Programming Language :: Python :: 3 :: Only",
]
dependencies = [
    "pypulseq",
    # "pypulseq@git+https://github.com/imr-framework/pypulseq#egg=dev",
    "numpy",    # "numpy==1.23.0" for pypulseq master release 1.4
    "plotly",
    "PyYAML",
    "pydantic>=2.11.7",
    "matplotlib",
    "pandas",
    "ismrmrd",
    "h5py",
]

# Dependency groupds (optional)
[project.optional-dependencies]
test = ["pytest", "pytest-cov", "pytest-xdist", "coverage", "codecov"]
lint = ["mypy", "ruff", "types-PyYAML"]
docs = ["sphinx", "pydata-sphinx-theme", "sphinx-pyproject", "sphinx-design"]
dev = ["line_profiler[ipython]", "nbformat>=4.2.0", "ipykernel", "ipython", "ipywidgets"]

[project.scripts]
nexus = "console.service.start_manager:main"

[tool.setuptools.package-data]
"console" = ["py.typed"]

[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = [".", "src"]


[tool.mypy]
files = ["src/console"]
warn_return_any = false
check_untyped_defs = true
warn_no_return = true
warn_unreachable = true
python_version = "3.10"
ignore_missing_imports = true
exclude = ["docs"]


[tool.ruff]
# Use "ruff check --preview" to also show check for rules which are in preview (e.g. whitespaces)
src = ["src"]
line-length = 120
indent-width = 4
target-version = "py310"
extend-exclude = ["src/console/spcm_control/spcm", "docs", "__init__.py"]

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["S101"]

[tool.ruff.lint]
# Enable linters
# E = pycodestyle (error)
# W = pycodestyle (warning)
# F = Pyflakes
# S = flake8-bandit
# I = isort
# N = pep8-naming
# D = pydocstyle
# NPY = numpy specific rules
select = ["E", "W", "F", "S", "I", "N", "D", "NPY"]


[tool.ruff.lint.flake8-type-checking]
strict = true

[tool.ruff.lint.pylint]
max-args = 10
max-branches = 15
max-statements = 50

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