Fix the --version flag (#106)

Author: btschwertfeger

README.md

@@ -149,8 +149,8 @@ python3 -m pip install python-cmethods
 ```
 
 The package is also available via conda-forge. See
-[conda-forge/python_cmethods-feedstock](https://github.com/conda-forge/python_cmethods-feedstock/tree/main) for more
-information.
+[conda-forge/python_cmethods](https://anaconda.org/conda-forge/python_cmethods)
+for more information.
 
 <a name="examples"></a>
 

cmethods/__init__.py

@@ -29,26 +29,36 @@
 
 import logging
 import sys
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from cloup import Context
 
 import cloup
 import xarray as xr
-from cloup import (
-    HelpFormatter,
-    HelpTheme,
-    Path,
-    Style,
-    command,
-    option,
-    option_group,
-    version_option,
-)
+from click import echo
+from cloup import HelpFormatter, HelpTheme, Path, Style, command, option, option_group
 from cloup.constraints import Equal, If, require_all
 
 from cmethods.core import adjust
 
 __all__ = ["adjust"]
 
 
+def print_version(
+    ctx: Context,
+    param: Any,  # noqa: ARG001
+    value: Any,
+) -> None:
+    """Prints the version of the package"""
+    if not value or ctx.resilient_parsing:
+        return
+    from importlib.metadata import version
+
+    echo(version("python-cmethods"))
+    ctx.exit()
+
+
 @command(
     context_settings={
         "auto_envvar_prefix": "CMETHODS",
@@ -63,7 +73,13 @@
         ),
     ),
 )
-@version_option(message="%version%")
+@option(
+    "--version",
+    is_flag=True,
+    callback=print_version,
+    expose_value=False,
+    is_eager=True,
+)
 @option(
     "--obs",
     "--observations",

doc/getting_started.rst

@@ -19,7 +19,7 @@ The `python-cmethods`_ module can be installed using the package manager pip:
     python3 -m pip install python-cmethods
 
 The package is also available via conda-forge. See
-`python_cmethods-feedstock`_ for more information.
+`python_cmethods-conda`_ for more information.
 
 Command-Line Interface Usage
 ----------------------------

doc/links.rst

@@ -7,7 +7,7 @@
 
 .. _python-cmethods: https://github.com/btschwertfeger/python-cmethods
 
-.. _python_cmethods-feedstock: https://github.com/conda-forge/python_cmethods-feedstock/tree/main
+.. _python_cmethods-conda: https://anaconda.org/conda-forge/python_cmethods
 
 .. _python-cmethods/issues: https://github.com/btschwertfeger/python-cmethods/issues
 

pyproject.toml

@@ -15,7 +15,13 @@ description = "A collection of bias correction techniques written in Python - fo
 readme = "README.md"
 license = { file = "LICENSE" }
 requires-python = ">=3.8"
-dependencies = ["xarray>=2022.11.0", "netCDF4>=1.6.1", "numpy", "cloup"]
+dependencies = [
+  "xarray>=2022.11.0",
+  "netCDF4>=1.6.1",
+  "numpy",
+  "click",
+  "cloup",
+]
 keywords = [
   "climate-science",
   "bias",
@@ -68,6 +74,7 @@ testpaths = ["tests"]
 [tool.pytest.ini_options]
 cache_dir = ".cache/pytest"
 markers = ["wip: Used to run a specific test by hand."]
+addopts = "--maxfail=1"
 
 [tool.coverage.run]
 source = ["cmethods"]