refactor: add version() function

.github/workflows/main.yml

@@ -208,7 +208,7 @@ jobs:
           # test image with latest tag
           docker run --rm \
             ${{ secrets.DOCKERHUB_USERNAME }}/nbiatoolkit:${LATEST_TAG} \
-            python -c "import nbiatoolkit; print(nbiatoolkit.__version__)"
+            NBIAToolkit
 
 
   test_image_with_latest_tag:
@@ -222,4 +222,4 @@ jobs:
         run: |
           docker run --rm \
             ${{ secrets.DOCKERHUB_USERNAME }}/nbiatoolkit:latest \
-            python -c "import nbiatoolkit; print(nbiatoolkit.__version__)"
+            NBIAToolkit

Dockerfile

@@ -13,7 +13,7 @@ LABEL maintainer="Jermiah Joseph"
 # install the dependencies
 RUN python -m pip install nbiatoolkit
 
-RUN python -c 'import nbiatoolkit; print(nbiatoolkit.__version__)'
+RUN python -c 'import nbiatoolkit; print(nbiatoolkit.version())'
 
 # On run, open a bash shell
 CMD ["/bin/bash"]

docs/Tutorial.ipynb

@@ -54,7 +54,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -68,23 +68,23 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "'0.10.9'"
+       "'NBIAToolkit version: 0.12.1'"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
     "# import nbiatoolkit \n",
-    "nbiatoolkit.__version__"
+    "nbiatoolkit.version()"
    ]
   },
   {

pyproject.toml

@@ -8,6 +8,7 @@ readme = "README.md"
 
 [tool.poetry.scripts]
 DICOMSorter = "nbiatoolkit.dicomsort:DICOMSorter_cli"
+NBIAToolkit = "nbiatoolkit:version"
 
 [tool.poetry.dependencies]
 python = ">=3.11 || 3.12"

src/nbiatoolkit/__init__.py

@@ -9,11 +9,14 @@
 # set __version__ variable
 __version__ = "0.12.1"
 
+def version():
+    return "NBIAToolkit version: {}".format(__version__)
+
 # import the modules
 from .nbia import NBIAClient
 from .auth import OAuth2
 from .logger.logger import setup_logger
 from .utils.nbia_endpoints import NBIA_ENDPOINTS
 
 # define the __all__ variable
-__all__ = ["NBIAClient", "OAuth2", "setup_logger", "NBIA_ENDPOINTS", "__version__"]
+__all__ = ["NBIAClient", "OAuth2", "setup_logger", "NBIA_ENDPOINTS", "version"]

src/nbiatoolkit/nbia.py

@@ -345,6 +345,7 @@ def parsePARAMS(self, params: dict) -> dict:
         return PARAMS
 
 
+
 # main
 if __name__ == "__main__":
     from pprint import pprint