psdi-data-conversion 0.1.6__tar.gz → 0.1.7__tar.gz

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog for PSDI Data Conversion
 
+## v0.1.7
+
+### New and Changed Functionality
+
+- Version, SHA, and service/prod modes now always shown in new About section on the Documentation page
+
+### Documentation Changes
+
+- Added information about deployment to CONTRIBUTING.md
+
+### Bugfixes
+
+- Environmental variable indicating dev or production mode should now be properly set for the deployed service
+
 ## v0.1.6
 
 ### New and Changed Functionality

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/CONTRIBUTING.md

@@ -15,7 +15,7 @@ This project uses a version of [GitLab Flow](https://about.gitlab.com/topics/ver
 
 The following tasks should be completed before merging a release candidate branch to `release`:
 
-- Detemine the target version based on the changes made:
+- Determine the target version based on the changes made:
 
   - If any breaking changes have been made (after version 1.0.0), the version will advance to the next major version - `X.Y.Z` to `(X+1).0.0`
   - Otherwise, if any features are added, or any breaking changes are made before version 1.0.0, the version will advance to the next minor version - `X.Y.Z` to `X.(Y+1).0`.
@@ -193,13 +193,13 @@ class MyFileConverter(FileConverter):
 converter = MyFileConverter
 ```
 
-That's all you need to do! The `psdi_data_conversion.converter` module parses all modules in the `converters` package to find converters, so if you've done everything correctly, it will find the new converter and register it for you. You can test that it is properly registered by using the CLA to run:
+That's all you need to do! The `psdi_data_conversion.converter` module parses all modules in the `converters` package to find converters, so if you've done everything correctly, it will find the new converter and register it for you. You can test that it is properly registered by using the CLI to run:
 
 ```bash
 psdi-data-convert -l
 ```
 
-Your new converter should appear, or else you will probably see an error message which will detail an exception raised when trying to register it. Note that until the converter's information is added to the database (the file `psdi_data_conversion/static/data/data.json`), the CLA will show that it is unable to perform any conversions, and it will fail on any conversion (believing it to be impossible) unless you provide the `--nc/--no-check` command-line flag.
+Your new converter should appear, or else you will probably see an error message which will detail an exception raised when trying to register it. Note that until the converter's information is added to the database (the file `psdi_data_conversion/static/data/data.json`), the CLI will show that it is unable to perform any conversions, and it will fail on any conversion (believing it to be impossible) unless you provide the `--nc/--no-check` command-line flag.
 
 For file converters which can be run with a call to a script, this can be streamlined even further by taking advantage of the `ScriptFileConverter` subclass. With this, the converter's subclass can be defined even more succinctly:
 
@@ -273,7 +273,7 @@ pip install --editable .[test]
 pytest
 ```
 
-This installs the project in a virtual environment in "editable" mode (which means the source files will be used from where they are rather than being copied, so any changes to them will be directly reflected in tests and uses of the CLA) and then calls `pytest` to run the unit tests in the project. `pytest` will automatically pick up any extra tests you add and run them as well.
+This installs the project in a virtual environment in "editable" mode (which means the source files will be used from where they are rather than being copied, so any changes to them will be directly reflected in tests and uses of the CLI) and then calls `pytest` to run the unit tests in the project. `pytest` will automatically pick up any extra tests you add and run them as well.
 
 #### Web App Integration
 
@@ -320,13 +320,13 @@ This project uses various GitHub workflows to perform Continuous Integration tas
 - Testing and scanning (triggered by pushes to `main`, `release`, `feature*`, and `rc*` branches)
 - Periodic checks for updates to common assets
 - Automatic creation of pull requests for `feature*` and `rc*` branches
-- Automatic tagging, publishing, and deployment of the `release` branch
+- Automatic tagging, publishing, and deployment of the `main` and `release` branches to the development, staging and production environments
 
-See the commons within the files for further details.
+See the comments within the files for further details. See also the [section on deployment](#deployment) for details specific to deployment tasks.
 
 ## Publishing
 
-The Python library, CLA, and local GUI are published as a Python package via PyPI. This section describes how the package is set up and how it's published.
+The Python library, CLI, and local GUI are published as a Python package via PyPI. This section describes how the package is set up and how it's published.
 
 ### Package Setup
 
@@ -338,7 +338,7 @@ The version of the package is set to be determined from the version control syst
 
 ### Initial Publication
 
-This section details the proceduce for the initial publication of this package - now that this is complete, this section is left in for reference in case of future need.
+This section details the procedure for the initial publication of this package - now that this is complete, this section is left in for reference in case of future need.
 
 First, it's necessary to install a couple required packages in order to build a Python package: `build` to build it and `twine` to upload it. These can be installed with pip via:
 
@@ -376,8 +376,68 @@ The management page can also be used to add or remove collaborators through the
 
 ## Deployment
 
-Deployment is handled by the `job-deploy-k8s.yml` reusable workflow, which is triggered from `ci-main.yml` to deploy to dev on each push to `main` and `ci-release.yml` to deploy to staging on each push to `release`. When a push to production is desired, it must be triggered manually by calling the `ci-deploy-production.yml` workflow on the `release` branch (it's set up to fail if run on any other branch).
+The `ci-main.yml`, `ci-release.yml` and `ci-deploy-production.yml` files in the `.github/workflows` directory house workflows which deploy
+the data conversion service to [Kubernetes](https://kubernetes.io/) clusters hosted in STFC.  There are three clusters, each of which correspond
+to a different deployment _environment_ for the data conversion service. The three environments are `development`, `staging` and `production`.
+Deployment to `development`, `staging` and `production` is done from either the `main` or `release` branch. The table below indicates which
+branch deploys to which environment. The table also shows, for each environment:
+- the URL on which the service is exposed once it is successfully deployed
+- the accessibility of the service. Depending on the environment the service is either accessible to the _public_ at the specified URL,
+  or accessible only to IP addresses within the _STFC and University of Southampton subnets_
+- the trigger used to invoke the workflow which deploys the service from the source branch. Deployment is either _automatic_
+  upon a commit to the source branch which passes the unit-tests job; or results from a _manual_ invocation of a workflow by a
+  developer.
+
+| Environment      | URL                                        | Accessibility                              | Source branch  | Deployment trigger    |
+|------------------|--------------------------------------------|--------------------------------------------|----------------|-----------------------|
+| `development`    | https://data-conversion-dev.psdi.ac.uk     | STFC and University of Southampton subnets | `main`         | Automatic             |
+| `staging`        | https://data-conversion-staging.psdi.ac.uk | STFC and University of Southampton subnets | `release`      | Automatic             |
+| `production`     | https://data-conversion.psdi.ac.uk         | public                                     | `release`      | Manual                |
+
+Thus the `main` is automatically deployed to the `development` environment, and the `release` branch is automatically deployed to the `staging`
+environment. However deployment from the `release` branch to the `production` environment is a manual process. This is to allow developers to
+manually check that the `release` version works correctly in the `staging` environment before deploying it to the `production` environment.
+The checks to `staging` before deployment to `production` should echo those described in the above
+section [Release Checklist and Procedure](#release-checklist-and-procedure).
+
+### How to deploy to the `production` environment
+
+To trigger the workflow which deploys the service to the `production` environment, from the [main page of the repo](https://github.com/PSDI-UK/psdi-data-conversion)
+navigate to [Actions](https://github.com/PSDI-UK/psdi-data-conversion/actions). Here you should see on the right a list of recent workflow
+runs, including whether or not they are successful (as indicated by a green tick); and on the left you should see a list of all workflows.
+
+The workflow which deploys the `release` branch to the `staging` environment is named `CI - Release`. As mentioned above, you should verify
+that this workflow successfully deployed the `release` version to `staging` before considering deploying to `production`. If you click on the
+latest workflow run of `CI - Release` then you can see a breakdown of the workflow into its constituent workflows. Note the `deploy-stfc-staging-k8s`
+job. If this job is successful then the `release` version has been successfully deployed to `staging`.
+
+Assuming this is the case, navigating back to [Actions](https://github.com/PSDI-UK/psdi-data-conversion/actions), note that there is a workflow
+listed on the left named `CI - Deploy to production cluster`. This is the workflow which must be invoked manually to deploy the `release`
+version to the `production` environment. Clicking on the link to this workflow gives
+[a list of recent invocations](https://github.com/PSDI-UK/psdi-data-conversion/actions/workflows/ci-deploy-production.yml) of the workflow.
+Moreover, a light blue banner appears which says `This workflow has a workflow_dispatch event trigger` on the left and has a `Run workflow` button
+on the right. To invoke the workflow, press this button, *select the `release` branch* as the option for `Use workflow from` dropdown menu, and
+then finally click the green `Run workflow` button. Once the workflow has been invoked you should be able to see its progress in real time on the
+same page.
+
+### Further technical details
+
+The `ci-main.yml`, `ci-release.yml` and `ci-deploy-production.yml` workflows leverage the `job-deploy-k8s.yml` callable workflow to do the heavy
+lifting with regards to deployment to STFC Kubernetes environments. The `job-deploy-k8s.yml` workflow is coded to be invoked on PSDI's GitHub
+runners. These runners are hosted within STFC's network, providing a means to access the three STFC Kubernetes clusters corresponding to the
+`development`, `staging` and `production` environments. The environment to be targeted for deployment is passed to the `job-deploy-k8s.yml`
+workflow as an input parameter. Given a target environment `<env>`, the `job-deploy-k8s.yml` workflow will deploy the service to the
+the `<env>` environment using the Kubernetes manifests stored in the `deploy`/<env>` directory of this repository.
+
+The workflow relies on several repository secrets, namely `KUBECONF`, `IMAGEPULLSECRET`, `CERTIFICATE_PRIVATE_KEY` and `CERTIFICATE_PEM` for
+various purposes.
+- `KUBECONF` provides Kubernetes-specific information pertaining to the the Kubernetes cluster for the target environment. Note that
+  `KUBECONF` is an _environment_-dependent secret, taking different values for each of the environments. 
+- `IMAGEPULLSECRET` enables the container image housing the data conversion service to be pulled from this GitHub repo to the PSDI runner
+- `CERTIFICATE_PRIVATE_KEY` and `CERTIFICATE_PEM` pertain to the TLS certificates for the service
+For further information see the `job-deploy-k8s.yml` file and aforementioned Kubernetes manifests.
+
+
 
-TODO - Describe details of setup
 
 The server can be configured by editing the environmental variables set in `Dockerfile`.

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psdi_data_conversion
-Version: 0.1.6
+Version: 0.1.7
 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/
@@ -243,6 +243,9 @@ Description-Content-Type: text/markdown
 
 # PSDI Data Conversion
 
+[![License Badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/brgillis/dbd938192dc4de9b7779978e515c0e79/raw/covbadge.json)
+
 Release date: 2024-04-29
 
 This is the repository for the PSDI PF2 Chemistry File Format Conversion project. The goal of this project is to provide utilities to assist in converting files between the many different file formats used in chemistry, providing information on what converters are available for a given conversion and the expected quality of it, and providing multiple interfaces to perform these conversions. These interfaces are:

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/README.md

@@ -1,5 +1,8 @@
 # PSDI Data Conversion
 
+[![License Badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/brgillis/dbd938192dc4de9b7779978e515c0e79/raw/covbadge.json)
+
 Release date: 2024-04-29
 
 This is the repository for the PSDI PF2 Chemistry File Format Conversion project. The goal of this project is to provide utilities to assist in converting files between the many different file formats used in chemistry, providing information on what converters are available for a given conversion and the expected quality of it, and providing multiple interfaces to perform these conversions. These interfaces are:

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/app.py

@@ -197,7 +197,7 @@ def get_tag_and_sha() -> str:
 
 @app.route('/')
 def website():
-    """Return the web page along with the token
+    """Return the web page along with relevant data
     """
     tag, sha = get_tag_and_sha()
     return render_template("index.htm",
@@ -210,6 +210,16 @@ def website():
                            sha=sha)
 
 
+@app.route('/documentation.htm')
+def documentation():
+    """Return the documentation page
+    """
+    tag, sha = get_tag_and_sha()
+    return render_template("documentation.htm",
+                           tag=tag,
+                           sha=sha)
+
+
 @app.route('/convert/', methods=['POST'])
 def convert():
     """Convert file to a different format and save to folder 'downloads'. Delete original file. Note that downloading is

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/static/content/header-links.html

@@ -3,7 +3,7 @@
 <a href="../../" class="navbar__item navbar__link">Home</a>
 <a href="report.htm" class="navbar__item navbar__link">Report Missing Format/Conversion</a>
 <a href="feedback.htm" class="navbar__item navbar__link">Provide Feedback</a>
-<a href="documentation.htm" class="navbar__item navbar__link">Documentation</a>
+<a href="../../documentation.htm" class="navbar__item navbar__link">Documentation</a>
 <a href="download.htm" class="navbar__item navbar__link service-only">Download</a>
 <a href="accessibility.htm" class="navbar__item navbar__link">Accessibility</a>
 <a href="mailto:support@psdi.ac.uk" class="navbar__item navbar__link" id="mail">Contact Us</a>

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/static/content/index-versions/header-links.html

@@ -3,7 +3,7 @@
 <a href="./" class="navbar__item navbar__link">Home</a>
 <a href="static/content/report.htm" class="navbar__item navbar__link">Report Missing Format/Conversion</a>
 <a href="static/content/feedback.htm" class="navbar__item navbar__link">Provide Feedback</a>
-<a href="static/content/documentation.htm" class="navbar__item navbar__link">Documentation</a>
+<a href="./documentation.htm" class="navbar__item navbar__link">Documentation</a>
 <a href="static/content/download.htm" class="navbar__item navbar__link service-only">Download</a>
 <a href="static/content/accessibility.htm" class="navbar__item navbar__link">Accessibility</a>
 <a href="mailto: psdi@soton.ac.uk" class="navbar__item navbar__link" id="mail">Contact</a>

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/static/content/index-versions/psdi-common-header.html

@@ -5,10 +5,8 @@
   <div class="header-left">
     <div class="navbar__brand">
       <a class="navbar__logo" href="https://psdi.ac.uk/">
-        <img src="static/img/psdi-logo-darktext.png" alt="PSDI logo"
-          class="lm-only">
-        <img src="static/img/psdi-logo-lighttext.png" alt="PSDI logo"
-          class="dm-only">
+        <img src="static/img/psdi-logo-darktext.png" alt="PSDI logo" class="lm-only">
+        <img src="static/img/psdi-logo-lighttext.png" alt="PSDI logo" class="dm-only">
       </a>
       <a class="navbar__title" href=".">
         <h5>Data Conversion Service</h5>
@@ -16,13 +14,18 @@
     </div>
   </div>
   <div class="navbar__items navbar__items--right">
-    <!-- This file contains the links that will appear in the top-right of the header bar for .html files in the index.htm page. --> <a href="./" class="navbar__item navbar__link">Home</a> <a href="static/content/report.htm" class="navbar__item navbar__link">Report Missing Format/Conversion</a> <a href="static/content/feedback.htm" class="navbar__item navbar__link">Provide Feedback</a> <a href="static/content/documentation.htm" class="navbar__item navbar__link">Documentation</a> <a href="static/content/download.htm" class="navbar__item navbar__link service-only">Download</a> <a href="static/content/accessibility.htm" class="navbar__item navbar__link">Accessibility</a> <a href="mailto: psdi@soton.ac.uk" class="navbar__item navbar__link" id="mail">Contact</a>
+    <!-- This file contains the links that will appear in the top-right of the header bar for .html files in the index.htm page. -->
+    <a href="./" class="navbar__item navbar__link">Home</a> <a href="static/content/report.htm"
+      class="navbar__item navbar__link">Report Missing Format/Conversion</a> <a href="static/content/feedback.htm"
+      class="navbar__item navbar__link">Provide Feedback</a> <a href="./documentation.htm"
+      class="navbar__item navbar__link">Documentation</a> <a href="static/content/download.htm"
+      class="navbar__item navbar__link service-only">Download</a> <a href="static/content/accessibility.htm"
+      class="navbar__item navbar__link">Accessibility</a> <a href="mailto: psdi@soton.ac.uk"
+      class="navbar__item navbar__link" id="mail">Contact</a>
     <button class="clean-btn color-mode-toggle" title="Switch between dark and light mode"
       aria-label="Lightmode/darkmode toggle button">
-      <img src="static/img/colormode-toggle-lm.svg" alt="Lightmode toggle icon"
-        class="lm-only">
-      <img src="static/img/colormode-toggle-dm.svg" alt="Darkmode toggle icon"
-        class="dm-only">
+      <img src="static/img/colormode-toggle-lm.svg" alt="Lightmode toggle icon" class="lm-only">
+      <img src="static/img/colormode-toggle-dm.svg" alt="Darkmode toggle icon" class="dm-only">
     </button>
   </div>
 </div>

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/static/content/psdi-common-header.html

@@ -5,10 +5,8 @@
   <div class="header-left">
     <div class="navbar__brand">
       <a class="navbar__logo" href="https://psdi.ac.uk/">
-        <img src="../img/psdi-logo-darktext.png" alt="PSDI logo"
-          class="lm-only">
-        <img src="../img/psdi-logo-lighttext.png" alt="PSDI logo"
-          class="dm-only">
+        <img src="../img/psdi-logo-darktext.png" alt="PSDI logo" class="lm-only">
+        <img src="../img/psdi-logo-lighttext.png" alt="PSDI logo" class="dm-only">
       </a>
       <a class="navbar__title" href="../../">
         <h5>Data Conversion Service</h5>
@@ -16,13 +14,18 @@
     </div>
   </div>
   <div class="navbar__items navbar__items--right">
-    <!-- This file contains the links that will appear in the top-right of the header bar for .html files in this directory. --> <a href="../../" class="navbar__item navbar__link">Home</a> <a href="report.htm" class="navbar__item navbar__link">Report Missing Format/Conversion</a> <a href="feedback.htm" class="navbar__item navbar__link">Provide Feedback</a> <a href="documentation.htm" class="navbar__item navbar__link">Documentation</a> <a href="download.htm" class="navbar__item navbar__link service-only">Download</a> <a href="accessibility.htm" class="navbar__item navbar__link">Accessibility</a> <a href="mailto:support@psdi.ac.uk" class="navbar__item navbar__link" id="mail">Contact Us</a>
+    <!-- This file contains the links that will appear in the top-right of the header bar for .html files in this directory. -->
+    <a href="../../" class="navbar__item navbar__link">Home</a> <a href="report.htm"
+      class="navbar__item navbar__link">Report Missing Format/Conversion</a> <a href="feedback.htm"
+      class="navbar__item navbar__link">Provide Feedback</a> <a href="../../documentation.htm"
+      class="navbar__item navbar__link">Documentation</a> <a href="download.htm"
+      class="navbar__item navbar__link service-only">Download</a> <a href="accessibility.htm"
+      class="navbar__item navbar__link">Accessibility</a> <a href="mailto:support@psdi.ac.uk"
+      class="navbar__item navbar__link" id="mail">Contact Us</a>
     <button class="clean-btn color-mode-toggle" title="Switch between dark and light mode"
       aria-label="Lightmode/darkmode toggle button">
-      <img src="../img/colormode-toggle-lm.svg" alt="Lightmode toggle icon"
-        class="lm-only">
-      <img src="../img/colormode-toggle-dm.svg" alt="Darkmode toggle icon"
-        class="dm-only">
+      <img src="../img/colormode-toggle-lm.svg" alt="Lightmode toggle icon" class="lm-only">
+      <img src="../img/colormode-toggle-dm.svg" alt="Darkmode toggle icon" class="dm-only">
     </button>
   </div>
 </div>

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/static/styles/format.css

@@ -145,11 +145,11 @@ select#dark-background option {
 
 /* We use the production-mode variable to control whether elements with the "prod-only" or "dev-only" class are shown
 */
-[production-mode=True] .prod-only {
+[production-mode=False] .prod-only {
   display: none;
 }
 
-[production-mode=False] .dev-only {
+[production-mode=True] .dev-only {
   display: none;
 }
 

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/static/styles/psdi-common.css

@@ -344,6 +344,11 @@ body>* {
   align-items    : center;
 }
 
+/* Applies only to buttons with this class not in the PSDI header, to not break docusaurus sites */
+.clean-btn {
+  margin: 0;
+}
+
 #psdi-header .clean-btn {
   background     : none;
   border         : none;

{psdi_data_conversion-0.1.6/psdi_data_conversion/static/content → psdi_data_conversion-0.1.7/psdi_data_conversion/templates}/documentation.htm

@@ -9,17 +9,20 @@
 <head>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <title>PSDI Data Conversion Service</title>
-  <link rel="icon" type="image/x-icon" href="../img/psdi-icon-dark.svg">
+  <link rel="icon" type="image/x-icon" href="./static/img/psdi-icon-dark.svg">
   <link href="https://fonts.googleapis.com/css?family=Lato:400" rel="stylesheet" type="text/css">
   <link href="https://fonts.googleapis.com/css?family=Open+Sans+Condensed:700" rel="stylesheet" type="text/css">
-  <link rel="stylesheet" href="../styles/format.css">
+  <link href="https://fonts.googleapis.com/css?family=Open+Sans:400" rel="stylesheet" type="text/css">
+  <link href="https://fonts.googleapis.com/css?family=Lexend:400" rel="stylesheet" type="text/css">
+  <link rel="stylesheet" href="{{url_for('static', filename='styles/format.css')}}">
 
   <script src="https://code.jquery.com/jquery-3.7.1.js" integrity="sha256-eKhayi8LEQwp4NKxN+CfCh+3qOVUtJn3QNZ0TciWLP4="
     crossorigin="anonymous"></script>
+  <script src="https://cdn.jsdelivr.net/jquery.dirtyforms/2.0.0/jquery.dirtyforms.min.js"></script>
 
-  <script src="../javascript/load_accessibility.js"></script>
-  <script src="../javascript/common.js" type="module"></script>
-  <script src="../javascript/psdi-common.js" type="module"></script>
+  <script src="static/javascript/load_accessibility.js"></script>
+  <script src="static/javascript/common.js" type="module"></script>
+  <script src="static/javascript/psdi-common.js" type="module"></script>
 </head>
 
 <body marginwidth="0">
@@ -28,6 +31,14 @@
   <div id="cover"></div>
 
   <header class="header" id="psdi-header"></header>
+  <script type="module">
+    import { setHeaderLinksSource, setHeaderSource, setFooterSource } from "./static/javascript/psdi-common.js";
+    // Due to the index being a template which will exist in a different directory once rendered, we need to set
+    // a non-default location of the header links file
+    setHeaderSource("{{url_for('static', filename='content/index-versions/psdi-common-header.html')}}");
+    setFooterSource("{{url_for('static', filename='content/index-versions/psdi-common-footer.html')}}");
+    setHeaderLinksSource("{{url_for('static', filename='content/index-versions/header-links.html')}}");
+  </script>
 
   <div class="hero">
     <div class="max-width-box">
@@ -84,6 +95,15 @@
         in the changes being lost. Note that page appearance may vary slightly according to the browser used.</p>
       <p>The colour options here are not compatible with the dark-mode toggle in the header bar. If a custom dark scheme
         is desired, the appropriate colours can be selected in light-mode.</p>
+      <h3>About</h3>
+      <p><strong>PSDI Data Conversion service</strong><br>
+        <span class="local-only">Local GUI</span><span class="service-only">Public web service</span> mode -
+        <span class="dev-only">Development</span><span class="prod-only">Production</span> build<br>
+        {% if tag %}<strong>Version:</strong> {{ tag }}<br>{% endif %}
+        {% if sha %}<span class="dev-only"><strong>SHA of latest commit:</strong> {{ sha }}<br></span>{% endif %}
+        <strong>Project source:</strong> <a
+          href="https://github.com/PSDI-UK/psdi-data-conversion">https://github.com/PSDI-UK/psdi-data-conversion</a><br>
+      </p>
       <div class="medGap"></div>
     </div>
   </form>

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/psdi_data_conversion/templates/index.htm

@@ -59,7 +59,7 @@
       <p>Your one-stop shop for file format conversion, PSDI's Data Conversion Service enables users to seamlessly
         convert between different file formats and assess the quality of proposed conversions. This is the web version
         of our service. To find out more about Data Conversion and our other tools, click
-        <a href="https://resources.psdi.ac.uk/resource-themes/7bcc430a-fdc9-413e-bf32-bf163236430b" id="more"
+        <a href="https://resources.psdi.ac.uk/service/8334f94b-1c6e-4034-a5ab-71c6df375cba" id="more"
           target="_blank">here.</a>
       </p>
       <div id="format-selection">
@@ -121,7 +121,7 @@
     </div>
   </form>
   {% if tag %}
-  <div class="secondary prod-only">
+  <div class="secondary dev-only">
     <div class="max-width-box">PSDI Data Conversion {{ tag }} {% if sha %} (SHA: {{ sha }}) {% endif %}</div>
   </div>
   {% endif %}

{psdi_data_conversion-0.1.6 → psdi_data_conversion-0.1.7}/pyproject.toml

@@ -93,9 +93,11 @@ exclude = [
 pythonpath = ["."]
 
 [tool.coverage.run]
-source_pkgs = ["psdi_data_conversion", "tests"]
+source_pkgs = ["psdi_data_conversion"]
 branch = true
-omit = []
+# app.py is tested via the Selenium tests, which are indirect enough that the coverage tool doesn't pick up that the
+# lines are being tested, so we exclude it from the coverage % calculation
+omit = ["*/testing/*", "app.py"]
 
 [tool.coverage.paths]
 tests = ["tests/python"]