StructuralGT/pyproject.toml at main · compass-stc/StructuralGT · 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
76
77
78
[build-system]
requires = ["setuptools",
            "wheel",
            "numpy>=2.0.0rc1",
            "cython>=3.0.11",
            "igraph",
            "eigen",
	    "pythran"
]

[project]
name = "StructuralGT"
version = "0.2.0"
dependencies = [
        'numpy>=2.0',
        'scipy',
        'scikit-image',
        'matplotlib',
        'networkx',
        'opencv-python',
        'pandas',
        'gsd>=3.0.0',
        'python-igraph',
        'eigen',
        'pytest',
        'cmake',
        'freud-analysis>=3.1.0',
        'ipywidgets',
]

[tool.ruff]
include = ["*.py", "*.ipynb"]
exclude = ["tests/data"]

[tool.ruff.lint]
select = [
    "B",   # flake8-bugbear
    "D",   # pydocstyle
    "E",   # pycodestyle-error
    "F",   # pyflakes
    "I",   # isort
    "N",   # pep8-naming
    "S",   # flake8-bandit
    "W",   # pycodestyle-warning
    "C4",  # check list comprehensions and generators
    "PT",  # pytest style checks
    "UP",  # pyupgrade
    "NPY", # check for use of deprecated numpy functions
    "SIM", # check for duplicate/needlessly verbose code
    "ISC", # checks for implicit string concatenation
    "RET", # check for unnecessary branches surround returned values
    "RUF", # reduce ambiguity in string concatenation and iterable combination
    "PIE790", # remove unnecessary pass statements
    "PIE794", # enable c-style single definition of variables
]
ignore = [
  "S101", # Assertions are a good thing
  "D105", # Magic methods don't require documentation.
  "D107", # __init__ methods don't require documentation.
  "ISC001", # Raises warning in ruff formatter
  "SIM116", # Allow certain branched if statements
  "E203", # Unstable
  "E501", # Sometimes lines need to be long.
]

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

[tool.ruff.lint.isort]
known-third-party = ["hypothesis", "pytest"]

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["D", "B018", "F811"]
"__init__.py" = ["F401"] # Do not remove "unused" imports in __init__.py files

[tool.ruff.format]
quote-style = "double"
indent-style = "space"