From 2e0c03da8ed317ed5417c4b0ee44b67e48b5b58c Mon Sep 17 00:00:00 2001 From: jgart Date: Tue, 25 Jul 2023 18:27:59 -0500 Subject: [PATCH] feat: Add `--version` and `-V` cli flag. Issue #: https://github.com/mkdocstrings/griffe/issues/186 PR #174: https://github.com/mkdocstrings/griffe/pull/187 --- src/griffe/__init__.py | 3 +++ src/griffe/cli.py | 2 ++ 2 files changed, 5 insertions(+) diff --git a/src/griffe/__init__.py b/src/griffe/__init__.py index 76e1ffc3..4bf51442 100644 --- a/src/griffe/__init__.py +++ b/src/griffe/__init__.py @@ -16,6 +16,9 @@ from griffe.loader import load from griffe.logger import get_logger +# For acceptable version formats, see https://www.python.org/dev/peps/pep-0440/ +__version__ = "0.32.3" + __all__: list[str] = [ "Attribute", "Class", diff --git a/src/griffe/cli.py b/src/griffe/cli.py index bb195408..e630807f 100644 --- a/src/griffe/cli.py +++ b/src/griffe/cli.py @@ -24,6 +24,7 @@ import colorama +from griffe import __version__ from griffe.diff import ExplanationStyle, find_breaking_changes from griffe.docstrings.parsers import Parser from griffe.encoders import JSONEncoder @@ -122,6 +123,7 @@ def get_parser() -> argparse.ArgumentParser: global_options = parser.add_argument_group(title="Global options") global_options.add_argument("-h", "--help", action="help", help=main_help) + global_options.add_argument("-V", "--version", action="version", version=f'%(prog)s ' + __version__) def add_common_options(subparser: argparse.ArgumentParser) -> None: common_options = subparser.add_argument_group(title="Common options")