psdi-data-conversion 0.1.0__tar.gz → 0.1.2__tar.gz

{psdi_data_conversion-0.1.0 → psdi_data_conversion-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psdi_data_conversion
-Version: 0.1.0
+Version: 0.1.2
 Summary: Chemistry file format conversion service, provided by PSDI
 Project-URL: Homepage, https://data-conversion.psdi.ac.uk/
 Project-URL: Documentation, https://psdi-uk.github.io/psdi-data-conversion/

{psdi_data_conversion-0.1.0 → psdi_data_conversion-0.1.2}/psdi_data_conversion/app.py

@@ -6,7 +6,6 @@ This script acts as a server for the PSDI Data Conversion Service website.
 """
 
 import json
-from multiprocessing import Lock
 import os
 import sys
 from argparse import ArgumentParser
@@ -14,6 +13,7 @@ from collections.abc import Callable
 from datetime import datetime
 from functools import wraps
 from hashlib import md5
+from multiprocessing import Lock
 from subprocess import run
 from traceback import format_exc
 from typing import Any
@@ -30,7 +30,9 @@ from psdi_data_conversion.database import get_format_info
 from psdi_data_conversion.file_io import split_archive_ext
 from psdi_data_conversion.main import print_wrap
 
-# Env var for the SHA of the latest commit
+# Env var for the tag and SHA of the latest commit
+TAG_EV = "TAG"
+TAG_SHA_EV = "TAG_SHA"
 SHA_EV = "SHA"
 
 # Env var for whether this is a production release or development
@@ -130,42 +132,80 @@ def limit_upload_size():
 limit_upload_size()
 
 
-def get_last_sha() -> str:
+def get_tag_and_sha() -> str:
     """Get the SHA of the last commit
     """
 
-    # First check if the SHA is provided through an environmental variable
-    ev_sha = os.environ.get(SHA_EV)
-    if ev_sha:
-        return ev_sha
+    # Get the tag of the latest commit
+    ev_tag = os.environ.get(TAG_EV)
+    if ev_tag:
+        tag = ev_tag
+    try:
+        # This bash command calls `git tag` to get a sorted list of tags, with the most recent at the top, then uses
+        # `head` to trim it to one line
+        cmd = "git tag --sort -version:refname | head -n 1"
+
+        out_bytes = run(cmd, shell=True, capture_output=True).stdout
+        tag = str(out_bytes.decode()).strip()
+
+    except Exception:
+        print("ERROR: Could not determine most recent tag. Error was:\n" + format_exc(),
+              file=sys.stderr)
+        tag = ""
 
+    # Get the SHA associated with this tag
+    ev_tag_sha = os.environ.get(TAG_SHA_EV)
+    if ev_tag_sha:
+        tag: str | None = ev_tag_sha
     try:
-        # This bash command calls `git log` to get info on the last commit, uses `head` to trim it to one line, then
-        # uses `gawk` to get just the second word of this line, which is the SHA of this commit
-        cmd = "git log -n 1 | head -n 1 | gawk '{print($2)}'"
+        cmd = f"git show {tag}" + " | head -n 1 | gawk '{print($2)}'"
 
         out_bytes = run(cmd, shell=True, capture_output=True).stdout
-        out_str = str(out_bytes.decode()).strip()
+        tag_sha = str(out_bytes.decode()).strip()
 
     except Exception:
-        print("ERROR: Could not determine SHA of most recent commit. Error was:\n" + format_exc(),
+        print("ERROR: Could not determine SHA for most recent tag. Error was:\n" + format_exc(),
               file=sys.stderr)
-        out_str = "N/A"
+        tag_sha = None
+
+    # First check if the SHA is provided through an environmental variable
+    ev_sha = os.environ.get(SHA_EV)
+    if ev_sha:
+        sha = ev_sha
+    else:
+        try:
+            # This bash command calls `git log` to get info on the last commit, uses `head` to trim it to one line, then
+            # uses `gawk` to get just the second word of this line, which is the SHA of this commit
+            cmd = "git log -n 1 | head -n 1 | gawk '{print($2)}'"
+
+            out_bytes = run(cmd, shell=True, capture_output=True).stdout
+            sha = str(out_bytes.decode()).strip()
+
+        except Exception:
+            print("ERROR: Could not determine SHA of most recent commit. Error was:\n" + format_exc(),
+                  file=sys.stderr)
+            sha = ""
+
+    # If the SHA of the tag is the same as the current SHA, we indicate this by returning a blank SHA
+    if tag_sha == sha:
+        sha = ""
 
-    return out_str
+    return (tag, sha)
 
 
 @app.route('/')
 def website():
     """Return the web page along with the token
     """
+    tag, sha = get_tag_and_sha()
     return render_template("index.htm",
                            token=token,
                            max_file_size=max_file_size,
                            max_file_size_ob=max_file_size_ob,
                            service_mode=service_mode,
                            production_mode=production_mode,
-                           sha=get_last_sha())
+                           tag=tag,
+                           sha=sha)
 
 
 @app.route('/convert/', methods=['POST'])
@@ -273,7 +313,7 @@ def feedback():
 
         # Write data in JSON format and send to stdout
         logLock.acquire()
-        sys.stdout.write(f"{json.dumps(entry) +  '\n'}")
+        sys.stdout.write(f"{json.dumps(entry) + '\n'}")
         logLock.release()
 
         return Response(status=201)

{psdi_data_conversion-0.1.0 → psdi_data_conversion-0.1.2}/psdi_data_conversion/templates/index.htm

@@ -120,9 +120,9 @@
       <div class="medGap"></div>
     </div>
   </form>
-  {% if sha %}
+  {% if tag %}
   <div class="secondary prod-only">
-    <div class="max-width-box">SHA: {{ sha }}</div>
+    <div class="max-width-box">PSDI Data Conversion {{ tag }} {% if sha %} (SHA: {{ sha }}) {% endif %}</div>
   </div>
   {% endif %}
   <script src="{{url_for('static', filename='/javascript/format.js')}}" type="module" language="JavaScript"></script>