hdmf-zarr/pyproject.toml at dev · hdmf-dev/hdmf-zarr · 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
143
[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "hdmf_zarr"
authors = [
  { name="Oliver Ruebel", email="oruebel@lbl.gov" },
  { name="Matthew Avaylon", email="mavaylon@lbl.gov" },
  { name="Ryan Ly", email="rly@lbl.gov" },
  { name="Stephanie Prince", email="smprince@lbl.gov" },
]
description = "A package defining a Zarr I/O backend for HDMF"
readme = "README.rst"
requires-python = ">=3.10"
license = {text = "BSD"}
classifiers = [
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "License :: OSI Approved :: BSD License",
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "Operating System :: Microsoft :: Windows",
    "Operating System :: MacOS",
    "Operating System :: Unix",
    "Topic :: Scientific/Engineering :: Medical Science Apps."
]
dependencies = [
    "hdmf>=4.1.0",
    "zarr>=2.18.0, <3.0",  # pin below 3.0 until HDMF-zarr supports zarr 3.0
    "numpy>=1.24.0",
    "numcodecs>=0.12.0, <0.16.0",  # numcodecs 0.16.0 is not compatible with some versions of zarr 2.18.* and those versions do not include this restriction
    "pynwb>=2.8.3",
    "threadpoolctl>=3.1.0",
]
dynamic = ["version"]

[project.optional-dependencies]
# all optional dependencies
full = [
    "tqdm>=4.41.0",
    "fsspec",
    "s3fs",
]

# all runtime optional dependencies
all = ["hdmf-zarr[full]"]

[dependency-groups]
# development dependencies
test = [
    "black",
    "codespell",
    "hdf5plugin",  # hdf5plugin is used to test conversion of plugin filters
    "pre-commit",
    "pytest",
    "pytest-cov",
    "python-dateutil",  # used in some tests
    "ruff",
    "scipy>=1.7",  # used in some tests
    "tox",
]

# documentation dependencies
docs = [
    "matplotlib>=3.6",
    "scipy>=1.7",  # used in some docs
    "sphinx>=4",  # improved support for docutils>=0.17
    "sphinx_rtd_theme>=1",  # <1 does not work with docutils>=0.17
    "sphinx-gallery>=0.16",
    "sphinx-copybutton>=0.5",
]


[project.urls]
"Homepage" = "https://github.com/hdmf-dev/hdmf-zarr"
"Bug Tracker" = "https://github.com/hdmf-dev/hdmf-zarr/issues"

[tool.hatch.version]
source = "vcs"

[tool.hatch.build.hooks.vcs]
# this file is created/updated when the package is installed and used in
# src/hdmf_zarr/__init__.py to set `hdmf_zarr.__version__`
# this allows the version to be accessible from python
version-file = "src/hdmf_zarr/_version.py"

[tool.hatch.build.targets.sdist]
exclude = [".git_archival.txt"]

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


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

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

[tool.coverage.report]
exclude_lines = [
    "pragma: no cover",
    "@abstract"
]
omit = [
    "*/hdmf_zarr/_due.py",
]

[tool.black]
line-length = 120
target-version = ['py313']
include = '\.pyi?$'
force-exclude = 'docs/*'

[tool.ruff]
lint.select = ["E", "F", "T100", "T201", "T203"]
exclude = [
  ".git",
  ".tox",
  "__pycache__",
  "build/",
  "dist/",
  "docs/source/conf.py",
  "src/hdmf_zarr/_due.py",
  "docs/source/tutorials/",
  "docs/_build/",
]
line-length = 120

[tool.ruff.lint.per-file-ignores]
"docs/gallery/*" = ["E402", "T201"]
"test_gallery.py" = ["T201"]

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