add --version flag and upgrade version handling (#88)

* add --version flag and upgrade version handling

panama/__init__.py

@@ -2,10 +2,9 @@
 from .constants import PDGID_ERROR_VAL
 from .read import read_DAT
 from .run import CorsikaRunner
+from .version import __logo__, __version__
 from .weights import add_weight_prompt, add_weight_prompt_per_event, get_weights
 
-__version__ = "0.7.1"
-
 __all__ = (
     "read_DAT",
     "get_weights",
@@ -15,4 +14,5 @@
     "cli",
     "PDGID_ERROR_VAL",
     "__version__",
+    "__logo__",
 )

panama/cli/cli.py

@@ -2,15 +2,15 @@
 
 import click
 
+from ..version import __logo__
 from .corsika_to_hdf5 import hdf5
 from .run import run
 
 
 @click.group()
 @click.option("--debug", "-d", default=False, is_flag=True, help="Enable debug output")
-def cli(
-    debug: bool,
-) -> None:
+@click.version_option(version=__logo__)
+def cli(debug: bool) -> None:
     """
     Command line interface for PANAMA, providing useful CORSIKA utilities.
 

panama/cli/corsika_to_hdf5.py

@@ -5,8 +5,8 @@
 
 import click
 
-from .._logo import get_logo
 from ..read import read_DAT
+from ..version import __logo__
 
 
 @click.command(context_settings={"show_default": True})
@@ -64,7 +64,7 @@ def hdf5(
         logger.setLevel(logging.DEBUG)
         logger.debug("debug log level activated")
 
-    logger.info(get_logo())
+    logger.info(__logo__)
 
     files = list(input)
 

panama/cli/run.py

@@ -7,8 +7,8 @@
 
 import click
 
-from .._logo import get_logo
 from ..run import CorsikaRunner
+from ..version import __logo__
 
 DEFAULT_TMP_DIR = environ.get("TMP_DIR", "/tmp/PANAMA")
 CORSIKA_PATH = environ.get(
@@ -133,7 +133,7 @@ def run(
         logger.setLevel(logging.DEBUG)
         logger.debug("debug log level activated")
 
-    logger.info(get_logo())
+    logger.info(__logo__)
 
     n = 0
     p = Path(tmp)

panama/_logo.py → panama/version.py

@@ -1,3 +1,8 @@
+# from importlib.metadata import version, packages_distributions
+# __version__ = version(__distribution__)
+# __distribution__ = packages_distributions["panama"][0]
+__version__ = "0.8.0"
+
 LOGO_TEMPLATE = r"""
 ,-.----.                           ,--.das     nd               ____ ulticore utils for corsik  7
 \    /  \     ,---,              ,--.'|   ,---,               ,'  , `.                    ,---,
@@ -15,8 +20,4 @@
   `---`                   '---'                       '---'                                     {}
 """
 
-
-def get_logo() -> str:
-    from . import __version__
-
-    return LOGO_TEMPLATE.format(f"v{__version__}")
+__logo__ = LOGO_TEMPLATE.format(f"v{__version__}")

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 authors = [
-    {name = "Ludwig Neste", email = "ludwig.neste@tu-dortmund.de"},
+    {name = "Ludwig Neste", email = "ludwig.neste@fysik.su.se"},
 ]
 license = {text = "MIT"}
 requires-python = ">= 3.8,<3.12"
@@ -104,7 +104,7 @@ strict = false
 plugins = [
     "sync-pre-commit-lock"
 ]
-version = { source = "file", path = "panama/__init__.py" }
+version = { source = "file", path = "panama/version.py" }
 
 [tool.pdm.dev-dependencies]
 dev = [

tests/test_meta.py

@@ -0,0 +1,11 @@
+from panama import __logo__, __version__
+from importlib.metadata import version
+
+def test_logo():
+    logo = __logo__
+    assert len(logo) > 500
+    assert "v" in logo
+
+
+def test_version():
+    assert __version__ == version("corsika-panama").replace("+editable", "")