ProbeFlow/pyproject.toml at main · SPMQT-Lab/ProbeFlow · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
[build-system]
requires = ["setuptools>=68"]
build-backend = "setuptools.build_meta"

[project]
name = "probeflow"
version = "0.0.0b0"  # beta — surfaces and on-disk formats may change
description = "ProbeFlow — STM scan browser, processor, and Createc↔Nanonis toolkit. Browse .sxm scans with colormaps, apply line corrections / background subtraction / smoothing / FFT / grain detection, and convert Createc .dat files to Nanonis .sxm + PNG from either a GUI or a bash-friendly CLI."
readme = "README.md"
license = {text = "MIT"}
requires-python = ">=3.11"
dependencies = [
  "numpy",
  "scipy",
  "pillow",
  "PySide6",
  "matplotlib",
  "shapely>=2.0",
]

[project.optional-dependencies]
dev      = ["pytest", "vulture"]
features = ["opencv-python", "scikit-learn"]
gwyddion = ["gwyfile"]
all      = ["opencv-python", "scikit-learn", "gwyfile", "pytest"]

[project.scripts]
probeflow = "probeflow.cli:main"
dat-sxm   = "probeflow.io.converters.createc_dat_to_sxm:main"
dat-png   = "probeflow.io.converters.createc_dat_to_png:main"

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

[tool.setuptools.packages.find]
include = ["probeflow", "probeflow.*"]

[tool.setuptools.package-data]
probeflow = [
  "assets/*.gif",
  "assets/*.png",
  "assets/toolbar/*.png",
  "data/file_cushions/*.bin",
  "data/file_cushions/*.json",
  "data/file_cushions/*.txt",
]

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

[tool.ruff]
line-length = 100
target-version = "py311"
extend-exclude = [
  "probeflow/data/file_cushions",
  "test_data",
]

[tool.ruff.lint]
# Start permissive: only catch real bugs (pyflakes). Expand the rule set
# once the codebase has been through a format pass. See CONTRIBUTING.md.
select = ["F"]
ignore = [
  "F401",  # unused-import — many compatibility shims re-export deliberately
  "F403",  # star-import — used in compatibility shims
  "F405",  # name may be undefined / from star-import
]

[tool.ruff.lint.per-file-ignores]
"probeflow/__init__.py" = ["F401", "F403"]
"probeflow/*/__init__.py" = ["F401", "F403"]
"probeflow/cli/__init__.py" = ["F401", "F403"]
"probeflow/gui/__init__.py" = ["F401", "F403"]
"probeflow/gui/processing.py" = ["F401", "F403"]