Use hatch to build package

* use `pyproject.toml` for project metadata
* version is now defined in `pyproject.toml`
* use importlib to get version (py3.8+)

Author: Kirill888

.github/workflows/main.yml

@@ -42,7 +42,7 @@ jobs:
 
       - name: Patch Package Versions
         run: |
-          find . -name _version.py | xargs python ./scripts/patch_version.py ${GITHUB_RUN_NUMBER:-0}
+          python ./scripts/patch_version.py ${GITHUB_RUN_NUMBER:-0} pyproject.toml
 
       - name: Build Dev Packages
         run: |

odc/stac/__init__.py

@@ -1,6 +1,5 @@
 """STAC Item -> ODC Dataset[eo3]."""
 
-from ._version import __version__  # isort:skip  this has to be 1st import
 from odc.loader._rio import configure_rio, configure_s3_access
 from odc.loader.types import RasterBandMetadata, RasterLoadParams, RasterSource
 
@@ -33,14 +32,13 @@
     "parse_items",
     "extract_collection_metadata",
     "output_geobox",
-    "__version__",
 )
 
 _eo3_methods = ["stac2ds", "infer_dc_product"]
 
 
 def __dir__():
-    return [*__all__, *_eo3_methods]
+    return [*__all__, *_eo3_methods, "__version__"]
 
 
 def __getattr__(name):
@@ -49,4 +47,9 @@ def __getattr__(name):
         from . import eo3
 
         return getattr(eo3, name)
+
+    if name == "__version__":
+        from importlib.metadata import version
+
+        return version(__name__)
     raise AttributeError(f"module {__name__} has no attribute {name}")

odc/stac/_version.py

@@ -1,6 +1,98 @@
 [build-system]
-requires = ["setuptools>=51.0.0", "wheel"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "odc-stac"
+description = "Tooling for converting STAC metadata to ODC data model"
+version = "0.4.0a1"
+authors = [
+    {name = "Open Data Cube"}
+]
+maintainers = [
+    {name = "Open Data Cube"}
+]
+readme = "README.rst"
+license = {text = "Apache License 2.0"}
+requires-python = ">=3.8"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Typing :: Typed"
+]
+dependencies = [
+    "affine",
+    "odc-geo>=0.4.7",
+    "odc-loader>=0.5.0",
+    "rasterio>=1.0.0,!=1.3.0,!=1.3.1",
+    "dask[array]",
+    "numpy>=1.20.0",
+    "pandas",
+    "pystac>=1.0.0,<2",
+    "toolz",
+    "xarray>=0.19"
+]
+
+[project.optional-dependencies]
+botocore = ["botocore"]
+docs = [
+    "sphinx",
+    "sphinx_rtd_theme",
+    "nbsphinx",
+    "sphinx-autodoc-typehints",
+    "matplotlib-inline",
+    "pandas",
+    "distributed",
+    "datacube>=1.8.8",
+    "ipython",
+    "ipykernel"
+]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-timeout",
+    "pystac_client",
+    "distributed",
+    "geopandas"
+]
+test-all = [
+    "pytest",
+    "pytest-cov",
+    "pytest-timeout",
+    "pystac_client",
+    "distributed",
+    "geopandas",
+    "datacube",
+    "stackstac"
+]
+
+[project.urls]
+Documentation = "https://odc-stac.readthedocs.io/en/latest/"
+"Bug Reporting" = "https://github.com/opendatacube/odc-stac/issues"
+Homepage = "https://github.com/opendatacube/odc-stac/"
+
+
+[tool.hatch.build.targets.wheel]
+packages = ["odc"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/odc",
+    "/README.rst",
+    "/tests",
+    "/scripts",
+    "/docs",
+    "/notebooks",
+    "/binder"
+]
 
 [tool.mypy]
 python_version = "3.10"
@@ -18,10 +110,8 @@ omit = [
 profile = "black"
 
 [tool.pylint.messages_control]
-
 max-line-length = 120
 max-args = 15
-
 disable = [
   "missing-function-docstring",
   "invalid-name",

pyproject.toml

@@ -1,9 +1,13 @@
+"""
+Patch version in pyproject.toml
+"""
+
 import re
 import sys
 
 from packaging import version
 
-version_rgx = re.compile("^\\s*__version__\\s*=\\s*['\"]([^'\"]*)['\"]")
+version_rgx = re.compile("^\\s*version\\s*=\\s*['\"]([^'\"]*)['\"]")
 
 
 def match_version(line):
@@ -30,18 +34,21 @@ def patch_version_lines(lines, build_number):
 
 
 def patch_file(fname, build_number):
-    with open(fname) as src:
+    with open(fname, encoding="utf-8") as src:
         lines = list(patch_version_lines(src, build_number))
-    with open(fname, "wt") as dst:
+    with open(fname, "wt", encoding="utf-8") as dst:
         dst.writelines(lines)
 
 
-if __name__ == "__main__":
-    args = sys.argv[1:]
+def main(args):
     if len(args) < 2:
         print(f"Usage: {sys.argv[0]} build-number [FILE]...")
 
     build_number, *files = args
     build_number = int(build_number)
     for f in files:
         patch_file(f, build_number)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

scripts/patch_version.py

@@ -1,17 +1,18 @@
 # pylint: disable=redefined-outer-name,missing-module-docstring,missing-function-docstring
+# pylint: disable=import-outside-toplevel
 import datetime as dt
 
 import pytest
 from dask.base import tokenize
 from odc.geo.geobox import GeoBox
-
 from odc.loader.types import (
     RasterBandMetadata,
     RasterGroupMetadata,
     RasterLoadParams,
     RasterSource,
     norm_key,
 )
+
 from odc.stac import ParsedItem, RasterCollectionMetadata
 from odc.stac.testing.stac import b_, mk_parsed_item
 
@@ -221,3 +222,10 @@ def test_tokenize(parsed_item_ab: ParsedItem):
 )
 def test_normkey(name, expected):
     assert norm_key(name) == expected
+
+
+def test_version():
+    from odc.stac import __version__
+
+    assert __version__ is not None
+    assert len(__version__.split(".")) == 3