use src layout and use hatch for packaging (#1592)

* src layout + migrate to hatch

* feat: git archival support

* rm test generated files

* Apply suggestions from code review

* Use relative imports

---------

Co-authored-by: Saransh Chopra <[email protected]>

Author: d-v-b

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -1,2 +1,3 @@
 *.py linguist-language=python
 *.ipynb linguist-documentation
+.git_archival.txt export-subst

.gitignore

@@ -62,8 +62,8 @@ target/
 # Jupyter
 .ipynb_checkpoints/
 
-# setuptools-scm
-zarr/version.py
+# VCS versioning
+src/zarr/_version.py
 
 # emacs
 *~

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
     rev: v1.7.1
     hooks:
       - id: mypy
-        files: zarr
+        files: src
         args: []
         additional_dependencies:
           - types-redis

docs/contributing.rst

@@ -1,6 +1,6 @@
 [build-system]
-requires = ["setuptools>=64.0.0", "setuptools-scm>1.5.4"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
 
 
 [project]
@@ -34,7 +34,7 @@ classifiers = [
     'Programming Language :: Python :: 3.11',
     'Programming Language :: Python :: 3.12',
 ]
-license = { text = "MIT" }
+license = "MIT"
 
 [project.optional-dependencies]
 jupyter = [
@@ -68,18 +68,13 @@ exclude_lines = [
 
 [tool.coverage.run]
 omit = [
-    "zarr/meta_v1.py",
+    "src/zarr/meta_v1.py",
     "bench/compress_normal.py",
 ]
 
-[tool.setuptools]
-packages = ["zarr", "zarr._storage", "zarr.tests"]
-license-files = ["LICENSE.txt"]
-
-[tool.setuptools_scm]
-version_scheme = "guess-next-dev"
-local_scheme = "dirty-tag"
-write_to = "zarr/version.py"
+[tool.hatch]
+version.source = "vcs"
+build.hooks.vcs.version-file = "src/zarr/_version.py"
 
 [tool.ruff]
 line-length = 100

pyproject.toml

@@ -49,7 +49,7 @@
     ZipStore,
 )
 from zarr.sync import ProcessSynchronizer, ThreadSynchronizer
-from zarr.version import version as __version__
+from zarr._version import version as __version__
 
 # in case setuptools scm screw up and find version to be 0.0.0
 assert not __version__.startswith("0.0.0")