Merge branch 'version' into 'main'

Version

See merge request !17

.gitignore

@@ -8,3 +8,5 @@ data
 *csv
 *npy
 dist
+app-version.json
+.venv

.gitlab-ci.yml

-variables:
-  POETRY_CACHE_DIR: ${CI_PROJECT_DIR}/.poetry
-  PYTHONUNBUFFERED: 1
 
-image: ${CI_REGISTRY}/devops/images/usgs/python:3.8
+image: ${CI_REGISTRY}/devops/images/usgs/python:3.10
 
 # Do not run for merge requests
 workflow:
@@ -27,7 +24,7 @@ default:
 Init:
   artifacts:
     paths:
-      - ${POETRY_CACHE_DIR}
+      - .venv
   script:
     - poetry install
   stage: init
@@ -72,6 +69,10 @@ Example:
 ####
 
 PyPi:
+  image:
+    name: ${CI_REGISTRY}/devops/images/usgs/python:3.10
+    docker:
+      user: root
   needs:
     - Format Check
     - Init
@@ -79,6 +80,8 @@ PyPi:
   only:
     - tags@ghsc/nshmp/ncm/TherMod
   script:
+    - apt-get install -y git
+    - poetry run app_version
     - pip install twine
     - poetry version ${CI_COMMIT_TAG}
     - poetry build

poetry.toml

@@ -4,3 +4,7 @@ url = "https://code.usgs.gov/api/v4/projects/2294/packages/pypi"
 
 [repositories.TherMod]
 url = "https://code.usgs.gov/api/v4/projects/1404/packages/pypi"
+
+[virtualenvs]
+create = true
+in-project = true

pyproject.toml

@@ -7,10 +7,11 @@ maintainers = ["Brandon Clayton <bclayton@usgs.gov>"]
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<3.12"
-ncm-database = "^0.4.0"
+ncm-database = "^0.5.2"
 netcdf4 = "^1.6.4"
 numpy = "1.24.0"
 scipy = "1.10.0"
+gitpython = "^3.1.43"
 
 [tool.poetry.group.dev.dependencies]
 pylint = "^2.17.5"
@@ -19,6 +20,7 @@ flake8 = "^6.0.0"
 isort = "^5.12.0"
 
 [tool.poetry.scripts]
+app_version = "scripts:app_version"
 setup = "scripts:setup"
 database = "scripts:database"
 thermod = "scripts:thermod"

scripts.py

 """ Scripts for Poetry
 """
 
+import json
 import os
+import re
 import sys
 
 from subprocess import check_call
@@ -10,6 +12,33 @@ from subprocess import check_call
 _project = "thermod"
 
 
+def app_version():
+    import git
+
+    version_file = open(f"{_project}/resources/app-version.json", "w+")
+
+    try:
+        repo = git.Repo(".")
+        gitHash = repo.head.commit.hexsha
+        version = repo.git.describe(tags=True, first_parent=True, always=True)
+        url = os.environ.get("CI_PROJECT_URL", repo.remotes.origin.url)
+
+        if "gitlab-ci-token" in url:
+            url = re.sub(r"gitlab-ci-token\:.*@", "", url)
+
+        version_info = dict(
+            gitHash=gitHash,
+            projectName="ncm-ws",
+            url=url,
+            version=version,
+        )
+
+        version_file.write(json.dumps(version_info, indent=2))
+    except Exception as error:
+        print("Failed to create version file. Writing blank file.")
+        version_file.write(json.dumps("{}"))
+
+
 def setup():
     # Setup GitHooks
     os.system("git config core.hookspath .githooks")
@@ -41,8 +70,8 @@ def help():
 
 def format_check():
     # Check code format
-    check_call(["isort", "--check", "--diff", ".", "--skip", ".poetry"])
-    check_call(["black", "--check", "--diff", ".", "--exclude", ".poetry"])
+    check_call(["isort", "--check", "--diff", ".", "--skip", ".venv"])
+    check_call(["black", "--check", "--diff", ".", "--exclude", ".venv"])
 
 
 def format():

thermod/__init__.py

 from thermod.ther_mod import *
+from thermod.version import thermod_version

thermod/version.py

+"""
+Author: U.S Geological Survey
+Description: Returns the app version info
+"""
+
+import json
+
+from os import path
+
+
+def thermod_version():
+    with open(f"{path.dirname(__file__)}/resources/app-version.json") as file:
+        return json.loads(file.read())