Swap to pyproject.toml setup

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Upcoming
 
+### Improvements
+* Swapped setup approach to the modern `pyproject.toml` standard. [#507](https://github.com/NeurodataWithoutBorders/nwbinspector/issues/507)
+
+
+
 # v0.5.2
 
 ### Deprecation (API)

docs/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+# Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements-rtd.txt
+    - method: pip
+      path: .

docs/requirements-rtd.txt

@@ -0,0 +1,7 @@
+numpy
+jsonschema==3.2.0
+Jinja2>=3.1.3
+sphinx==5.1.1
+sphinx_rtd_theme==0.5.1
+readthedocs-sphinx-search==0.3.2
+sphinx-copybutton==0.5.0

pyproject.toml

@@ -1,3 +1,67 @@
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "nwbinspector"
+version = "0.6.0"
+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 = "Ben Dichter",  email = "[email protected]"}
+]
+urls = { "Homepage" = "https://github.com/NeurodataWithoutBorders/nwbinspector" }
+license = {file = "license.txt"}
+keywords = ["nwb"]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: MacOS",
+    "License :: OSI Approved :: BSD License",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "pynwb",
+    "hdmf-zarr",
+    "fsspec",
+    "s3fs",
+    "requests",
+    "aiohttp",
+    "PyYAML",
+    "jsonschema",
+    "packaging",
+    "natsort",
+    "click",
+    "tqdm",
+    "isodate",
+    "numpy>=1.22.0,<2.0.0"  # TODO: remove 2.0 bound when HDMF supports
+]
+
+[project.optional-dependencies]
+dandi = [
+    "dandi",
+    "remfile",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.scripts]
+nwbinspector = "nwbinspector._nwbinspector_cli:_nwbinspector_cli"
+
+
+
 [tool.black]
 line-length = 120
 target-version = ['py37']

src/nwbinspector/__init__.py

@@ -1,3 +1,5 @@
+import importlib.metadata
+
 from ._version import __version__
 from ._registration import available_checks, register_check
 from ._types import Importance, Severity, InspectorMessage
@@ -23,6 +25,9 @@
 
 default_check_registry = {check.__name__: check for check in available_checks}
 
+# Still keeping the legacy magic version attribute requested by some users
+__version__ = importlib.metadata.version(distribution_name="nwbinspector")
+
 __all__ = [
     "available_checks",
     "default_check_registry",