From 6fb7c7ab1b5ea285a59a86fc4fe96430ac02b74b Mon Sep 17 00:00:00 2001 From: janezlapajne Date: Wed, 25 Sep 2024 10:55:03 +0200 Subject: [PATCH] refactor: Add installation verification and version module --- docs/install.md | 8 ++++++++ siapy/__init__.py | 3 +++ siapy/__version__.py | 6 ++++++ 3 files changed, 17 insertions(+) create mode 100644 siapy/__version__.py diff --git a/docs/install.md b/docs/install.md index 8e8938b..a4c94ba 100644 --- a/docs/install.md +++ b/docs/install.md @@ -47,6 +47,14 @@ cd siapy make install ``` +### Verify Installation + +To verify that siapy has been installed correctly, you can run: + +```bash +python -c "import siapy; print(siapy.__version__)" +``` + ## Troubleshooting If you encounter any issues during installation, consider the following solutions: diff --git a/siapy/__init__.py b/siapy/__init__.py index e69de29..6ebb05a 100644 --- a/siapy/__init__.py +++ b/siapy/__init__.py @@ -0,0 +1,3 @@ +from .__version__ import __version__ + +__all__ = ["__version__"] diff --git a/siapy/__version__.py b/siapy/__version__.py new file mode 100644 index 0000000..0a2186f --- /dev/null +++ b/siapy/__version__.py @@ -0,0 +1,6 @@ +from importlib import metadata + +try: + __version__ = metadata.version("siapy") +except metadata.PackageNotFoundError: + __version__ = "0.0.0"