ndx-spikesorting/pyproject.toml at main · catalystneuro/ndx-spikesorting · 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
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "ndx-spikesorting"
version = "0.1.0"
authors = [
    { name="Alessio Buccino", email="h.mayorquin@gmail.com" },
]
description = "An NWB extension for spike sorting outputs and extensions"
readme = "README.md"
requires-python = ">=3.10,<3.14"
license = "MIT"
classifiers = [
    # TODO: update these classifiers before release
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
]
keywords = [
    'NeurodataWithoutBorders',
    'NWB',
    'nwb-extension',
    'ndx-extension',
]
dependencies = [
    "pynwb>=3.1.3",
    "hdmf>=4.2.0",
]

[dependency-groups]
test = [
    "coverage>=7.5.4",
    "pytest>=8.2.2",
    "pytest-cov>=5.0.0",
    "pytest-subtests>=0.12.1",
    "python-dateutil>=2.8.2",
]

docs = [
    "hdmf-docutils>=0.4.7",
]

dev = [
    "black>=24.4.2",
    "codespell>=2.3.0",
    "ipykernel>=7.1.0",
    "pre-commit>=3.5.0",
    "ruff>=0.4.10",
    "spikeinterface>=0.103.2",
    "spikeinterface-gui[desktop,web]>=0.12.0",
    "neuroconv",
    {include-group = "docs"},
    {include-group = "test"},
]
min-reqs = [
    "pynwb==3.1.3",
    "hdmf==4.2.0",
]

# TODO: add URLs before release
# [project.urls]
# "Homepage" = "https://github.com/organization/package"
# "Documentation" = "https://package.readthedocs.io/"
# "Bug Tracker" = "https://github.com/organization/package/issues"
# "Discussions" = "https://github.com/organization/package/discussions"
# "Changelog" = "https://github.com/organization/package/blob/main/CHANGELOG.md"

# Include only the source code under `src/pynwb/ndx_spikesorting` and the spec files under `spec`
# in the wheel.
[tool.hatch.build.targets.wheel]
packages = [
    "src/pynwb/ndx_spikesorting",
    "spec"
]

# Rewrite the path to the `spec` directory to `ndx_spikesorting/spec`.
# `ndx_spikesorting/__init__.py` will look there first for the spec files.
# The resulting directory structure within the wheel will be:
# ndx_spikesorting/
# ├── __init__.py
# ├── spec
# └── widgets
[tool.hatch.build.targets.wheel.sources]
"spec" = "ndx_spikesorting/spec"

# The source distribution includes everything in the package except for the `src/matnwb` directory and
# git and github-related files.
[tool.hatch.build.targets.sdist]
exclude = [
    ".git*",
    "src/matnwb",
]

[tool.uv]
constraint-dependencies = ["numcodecs<0.16"]


[tool.pytest.ini_options]
# uncomment below to run pytest always with code coverage reporting. NOTE: breakpoints may not work
# addopts = "--cov --cov-report html"

[tool.codespell]
skip = "htmlcov,.git,.mypy_cache,.pytest_cache,.coverage,*.pdf,*.svg,venvs,.tox,./docs/_build/*,*.ipynb"

[tool.coverage.run]
branch = true
source = ["ndx_spikesorting"]

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "@abstract"
]

[tool.black]
line-length = 120
preview = true
exclude = ".git|.mypy_cache|.tox|.venv|venv|.ipynb_checkpoints|_build/|dist/|__pypackages__|.ipynb|docs/"

[tool.ruff]
lint.select = ["E", "F", "T100", "T201", "T203", "C901"]
exclude = [
  "docs/source/conf.py", "src/pynwb/ndx_spikesorting/__init__.py"
]
line-length = 120

[tool.ruff.lint.per-file-ignores]
"src/spec/create_extension_spec.py" = ["T201"]

[tool.ruff.lint.mccabe]
max-complexity = 17