pyproject.toml

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "pypulseq"
version = "1.4.2"
authors = [{ name = "Keerthi Sravan Ravi", email = "ks3621@columbia.edu" }]
maintainers = [
  { name = "Bilal Tasdelen" },
  { name = "Frank Ziljstra" },
  { name = "Patrick Schuenke" },
]
description = "Pulseq in Python"
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.6.3"
classifiers = [
  "Programming Language :: Python :: 3",
  "Operating System :: OS Independent",
]
dependencies = [
  "coverage>=6.2",
  "matplotlib>=3.5.2",
  "numpy>=1.19.5",
  "scipy>=1.8.1",
]

[project.optional-dependencies]
sigpy = ["sigpy>=0.1.26"]
test = [
  "coverage",
  "codecov",
  "pre-commit",
  "pytest",
  "pytest-cov",
  "pytest-xdist",
]

[project.urls]
Homepage = "https://github.com/imr-framework/pypulseq"
Issues = "https://github.com/imr-framework/pypulseq/issues"
Documentation = "https://pypulseq.readthedocs.io/en/latest/"

[tool.setuptools]
include-package-data = true

[tool.setuptools.package-data]
"pypulseq.SAR" = ["QGlobal.mat"]

[tool.setuptools.dynamic]
version = { attr = "version.__version__" }

[tool.ruff]
line-length = 120
extend-exclude = ["__init__.py"]
exclude = ["doc/**", "examples/**"]

# RUFF section
[tool.ruff.lint]
select = [
  "A",   # flake8-builtins
  "ARG", # flake8-unused-arguments
  "B",   # flake8-bugbear
  "C4",  # flake8-comprehensions
  "COM", # flake8-commas
  # "D",   # pydocstyle
  # "E",   # pycodestyle errors
  "F", # Pyflakes
  # "FA", # flake8-future-annotations
  "I", # isort
  # "N",   # pep8-naming
  "NPY", # NumPy-specific rules
  "RUF", # Ruff-specific rules
  "S",   # flake8-bandit
  "SIM", # flake8-simplify
  # "UP",  # pyupgrade
  "PIE", # flake8-pie
  "PTH", # flake8-use-pathlib
  "Q",   # flake8-quotes
  "W",   # pycodestyle warnings
  "YTT", # flake8-2020
  # "ERA", # flake8-eradicate
]

extend-select = [
  # "ANN001", #  type annotation for function argument
  # # "ANN201", #  return type annonation public function
  # # "ANN205", #  return type annonation static method
  # # "ANN401", #  any type annotation
  # # "BLE001", #  blind exception
  # # "D107",   #  missing docstring in __init__
  # # "D417",   #  undocumented-parameter
]

ignore = [
  "B028",   #  explicit "stacklevel" arg in warnings
  "COM812", #  missing-trailing-comma (conflict with formatter)
  "PTH123", #  use of Path.open
  "S101",   #  use of assert
  "S307",   #  use of possibly insecure eval function
  "S311",   #  standard pseudo-random generators
  "S324",   #  insecure hash function
  "SIM108", #  if-else-block-instead-of-if-exp
  "SIM115", #  use of context manager
]

[tool.ruff.lint.isort]
force-single-line = false
split-on-trailing-comma = false

[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
inline-quotes = "single"

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

[tool.ruff.format]
quote-style = "single"
skip-magic-trailing-comma = false

[tool.typos.default]
locale = "en-us"
exclude = ["examples/**"]

# PyTest section
[tool.pytest.ini_options]
testpaths = ["tests"]
filterwarnings = [
  "error",
  # Suppress error in debugpy due to mpl deprecation to debug tests.
  "ignore::matplotlib._api.deprecation.MatplotlibDeprecationWarning:pydev",
]
markers = ["sigpy: tests that require sigpy"]