Added --version option to CLI

Author: forman

.gitignore

@@ -1,4 +1,5 @@
 testdata/
+site/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

CHANGES.md

@@ -1,10 +1,7 @@
-## Version 0.2.1 (in development)
+## Version 0.3.0 (in development)
 
 ### Enhancements
 
-* It is now possible to configure runtime profiling of the `zappend`
-  processing using the new configuration setting `profiling`. [#39]
-
 * Allow for passing custom slice sources via the configuration.
   The new configuration setting `slice_source` is the name of a class 
   derived from `zappend.api.SliceSource` or a function that creates an instance 
@@ -13,6 +10,11 @@
   passed to the constructor of the specified class or the factory function. 
   [#27]
 
+* It is now possible to configure runtime profiling of the `zappend`
+  processing using the new configuration setting `profiling`. [#39]
+
+* Added `--version` option to CLI. [#42]
+
 * Using `sizes` instead of `dims` attribute of `xarray.Dataset` in 
   implementation code. [#25] 
 

docs/cli.md

@@ -22,7 +22,7 @@ Options:
                          'target_dir' configuration field.
   --dry-run              Run the tool without creating, changing, or deleting
                          any files.
-  --profiling TEXT       Path for profiling output. Switches on profiling.  
+  --version              Show version and exit.
   --help-config json|md  Show configuration help and exit.
   --help                 Show this message and exit.
 ```

setup.cfg

@@ -2,7 +2,7 @@
 name = zappend
 version = attr: zappend.__version__
 author = Norman Fomferra
-description = Tool for creating and updating a Zarr datacubes from smaller slices
+description = Tool for robustly creating and updating Zarr datacubes from smaller slices
 long_description = file: README.md
 long_description_content_type = text/markdown
 keywords = analysis ready data, data science, datacube, xarray, zarr
@@ -14,6 +14,7 @@ project_urls =
 	Changelog = https://github.com/bcdev/zappend/blob/main/CHANGES.md
 
 [options]
+packages = find:
 python_requires = >=3.10
 install_requires = file: requirements.txt
 
@@ -25,6 +26,13 @@ doc = file: requirements-doc.txt
 console_scripts =
     zappend = zappend.cli:zappend
 
+[options.packages.find]
+exclude =
+    test*
+    doc*
+    site*
+    htmlcov*
+
 [flake8]
 max-line-length = 88
 extend-ignore = E203

tests/test_cli.py

@@ -5,6 +5,7 @@
 import unittest
 from click.testing import CliRunner
 
+from zappend import __version__
 from zappend.cli import zappend
 from zappend.fsutil.fileobj import FileObj
 from .helpers import clear_memory_fs
@@ -15,6 +16,13 @@ class CliTest(unittest.TestCase):
     def setUp(self):
         clear_memory_fs()
 
+    def test_version(self):
+        runner = CliRunner()
+        # noinspection PyTypeChecker
+        result = runner.invoke(zappend, ["--version"])
+        self.assertEqual(0, result.exit_code)
+        self.assertEqual(f"{__version__}\n", result.output)
+
     def test_help(self):
         runner = CliRunner()
         # noinspection PyTypeChecker

zappend/__init__.py

@@ -2,4 +2,4 @@
 # Permissions are hereby granted under the terms of the MIT License:
 # https://opensource.org/licenses/MIT.
 
-__version__ = "0.2.1.dev0"
+__version__ = "0.3.0.dev0"

zappend/cli.py

@@ -28,6 +28,11 @@
     is_flag=True,
     help="Run the tool without creating, changing," " or deleting any files.",
 )
+@click.option(
+    "--version",
+    is_flag=True,
+    help="Show version and exit.",
+)
 @click.option(
     "--help-config",
     metavar="json|md",
@@ -39,6 +44,7 @@ def zappend(
     config: tuple[str, ...],
     target: str | None,
     dry_run: bool,
+    version: bool,
     help_config: str | None,
 ):
     """Create or update a Zarr datacube TARGET from slice datasets SLICES.
@@ -49,6 +55,10 @@ def zappend(
     be rolled back, in case the append operation fails. This ensures integrity of the
     target data cube given by TARGET or in CONFIG.
     """
+    if version:
+        from zappend import __version__
+
+        return click.echo(f"{__version__}")
 
     if help_config:
         return _show_config_help(help_config)
@@ -70,7 +80,7 @@ def _show_config_help(config_help_format):
     from zappend.config import get_config_schema
 
     text = get_config_schema(format=config_help_format)
-    print(text + "\n")
+    click.echo(text + "\n")
 
 
 if __name__ == "__main__":