Merge pull request #89 from bcdev/pont-88-pyproject

Move all project configuration to pyproject.toml

Author: pont-us

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+# Make line length conform to black's default
+max-line-length = 88
+# Workaround for https://github.com/PyCQA/pycodestyle/issues/373 ;
+# see also
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#pycodestyle
+extend-ignore = E203

.github/workflows/tests.yml

@@ -27,8 +27,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements-dev.txt
-        pip install -r requirements.txt
+        pip install .[dev,doc]
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

CHANGES.md

@@ -1,7 +1,10 @@
-## Version 0.7.0 (in development)
+## Version 0.7.1 (in development)
 
 * Fixed link to _slice sources_ in documentation main page.
 
+* Moved all project configuration to `pyproject.toml` and removed
+  `setup.cfg` and requirements files. (#88)
+
 ## Version 0.7.0 (from 2024-03-19)
 
 * Made writing custom slice sources easier and more flexible: (#82)

docs/start.md

@@ -9,6 +9,11 @@ version from PyPI:
 pip install zappend
 ```
 
+You can replace `zappend` with `zappend[dev]` in the above command to also
+install development dependencies, with `zappend[doc]` to also install
+documentation-building dependencies, or with `zappend[dev,doc]` to get both
+additional dependency sets.
+
 To install the latest version for development, clone the
 [repository](https://github.com/bcdev/zappend), and with the repository’s root
 directory as the current working directory execute:

pyproject.toml

@@ -3,3 +3,69 @@ requires = [
   "setuptools >= 40.9.0",
 ]
 build-backend = "setuptools.build_meta"
+
+[project]
+name = "zappend"
+dynamic = ["version"]
+authors = [
+  {name = "Norman Fomferra", email = "[email protected]"}
+]
+description = """\
+  Tool for robustly creating and updating Zarr datacubes from smaller slices\
+  """
+keywords = [
+  "analysis ready data", "data science", "datacube", "xarray", "zarr"
+]
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {text = "MIT"}
+requires-python = ">=3.10"
+dependencies = [
+  "click",
+  "dask",
+  "fsspec",
+  "jsonschema",
+  "numcodecs",
+  "numpy",
+  "pyyaml",
+  "xarray",
+  "zarr"
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "zappend.__version__"}
+
+[tool.setuptools.packages.find]
+exclude = [
+  "test*",
+  "doc*",
+  "site*",
+  "htmlcov*"
+]
+
+[project.scripts]
+zappend = "zappend.cli:zappend"
+
+[project.optional-dependencies]
+dev = [
+  "pytest",
+  "pytest-cov",
+  "black",
+  "flake8",
+  "flake8-bugbear",
+  "h5netcdf",
+  "s3fs",
+  "scipy",
+  "pyproj"
+]
+doc = [
+  "mkdocs",
+  "mkdocs-material",
+  "mkdocstrings",
+  "mkdocstrings-python"
+]
+
+[project.urls]
+Documentation = "https://bcdev.github.io/zappend/"
+Issues = "https://github.com/bcdev/zappend/issues"
+Changelog = "https://github.com/bcdev/zappend/blob/main/CHANGES.md"
+Repository = "https://github.com/bcdev/zappend"