nwbinspector/pyproject.toml at dev · NeurodataWithoutBorders/nwbinspector · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "nwbinspector"
version = "0.7.2"
description = "Tool to inspect NWB files for best practices compliance."
readme = "README.md"
authors = [
    {name = "Cody Baker"},
    {name = "Steph Prince"},
    {name = "Szonja Weigl"},
    {name = "Heberto Mayorquin"},
    {name = "Paul Adkisson"},
    {name = "Luiz Tauffer"},
    {name = "Ryan Ly"},
    {name = "Ben Dichter",  email = "ben.dichter@catalystneuro.com"}
]
urls = { "Homepage" = "https://github.com/NeurodataWithoutBorders/nwbinspector" }
license = {file = "license.txt"}
keywords = ["nwb"]
classifiers = [
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Operating System :: POSIX :: Linux",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: MacOS",
    "License :: OSI Approved :: BSD License",
]
requires-python = ">=3.10"
dependencies = [
    "pynwb>=3.1",   # NWB Inspector should always be used with most recent minor versions of PyNWB
    "hdmf-zarr",
    "fsspec",
    "requests",
    "aiohttp",
    "PyYAML",
    "jsonschema",
    "packaging",
    "natsort",
    "click",
    "tqdm",
    "isodate",
]

[project.optional-dependencies]
dandi = [
    "dandi",
    "remfile",
]

[tool.hatch.build.targets.sdist]
exclude = [
    ".git*",
    "codecov.yml",
    ".pre-commit-config.yaml",
]

[tool.hatch.build.targets.wheel]
packages = ["src/nwbinspector"]


[project.scripts]
nwbinspector = "nwbinspector._nwbinspector_cli:_nwbinspector_cli"


[tool.black]
line-length = 120
target-version = ['py310']
include = '\.pyi?$'
extend-exclude = '''
/(
  \.toml
  |\.rst
  |\.md
  |\.yml
  |\.txt
  |\.sh
  |\.git
  |\.ini
  |\.hg
  |\.mypy_cache
  |\.tox
  |\.venv
  |build
  |dist
)/
'''


[tool.ruff]
exclude = ["docs/*"]

[tool.ruff.lint]
# TODO: eventually, expand to other 'D', and other 'F' linting
select = [
    "F401",
    "F541",
    "I",
    "ANN001",
    "ANN201",
    "ANN202",
    "ANN205",
    "ANN206",
]
fixable = ["ALL"]

[tool.ruff.lint.per-file-ignores]
"src/nwbinspector/__init__.py" = ["I"]  # Must maintain explicit order for imports for check registration
"src/nwbinspector/utils/__init__.py" = ["F401", "I"]  # Several items planned for long-term deprecation

# Temporarily keeping all exposure below for back-compatibility
# Deprecation scheduled for 9/15/2024
"src/nwbinspector/nwbinspector/__init__.py" = ["F401", "I"]
"src/nwbinspector/inspector_tools/__init__.py" = ["F401", "I"]
"src/nwbinspector/version/__init__.py" = ["F401", "I"]
"src/nwbinspector/register_checks/__init__.py" = ["F401", "I"]
"tests/*" = ["ANN"]

[tool.ruff.lint.isort]
relative-imports-order = "closest-to-furthest"
known-first-party = ["nwbinspector"]


[tool.codespell]
skip = '.git*,*.pdf,*.css,allen_ccf_structure_names.json'
check-hidden = true
ignore-words-list = 'assertin'

[dependency-groups]
dev = [
    "pre-commit>=4.2.0",
    "pytest>=8.4.2",
]