psdi-data-conversion 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

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/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/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/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/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/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/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/{static/content → 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/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.5.dist-info → psdi_data_conversion-0.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psdi_data_conversion
-Version: 0.1.5
+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.5.dist-info → psdi_data_conversion-0.1.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 psdi_data_conversion/__init__.py,sha256=urMsTqsTHTch1q4rMT9dgGnrvdPFMP9B8r-6Kr8H5sE,404
-psdi_data_conversion/app.py,sha256=RxWkfqoDDNhRH-HlZ3pW_p-EmvIxwDOspwVG5A4SD9I,17254
+psdi_data_conversion/app.py,sha256=knw1gCOdm5K3XWwAMhWVqqPY5fu-0EqUA2a_7IcL8m8,17512
 psdi_data_conversion/constants.py,sha256=Hq2OVbcSkcv6T87-YJlo1PVlr9ILlB4H3E9JYjzvCF4,7423
 psdi_data_conversion/converter.py,sha256=Y77mqH2OKxf2YelphWDl82AKoRa-APle-l3e8wG_WZA,27315
 psdi_data_conversion/database.py,sha256=XzKvtT-cFmKLWLo5OBB5CV_rGHuqEEuENNyZnbS39qE,56419
@@ -26,16 +26,15 @@ psdi_data_conversion/static/content/accessibility.htm,sha256=5mzlPM-d5KBoOuvuBTm
 psdi_data_conversion/static/content/convert.htm,sha256=sw4U8yQQXNYXl2ruYPfg6qIMozL2KMpWlKcAzn208X8,7166
 psdi_data_conversion/static/content/convertato.htm,sha256=IQ2PUodkWdZbbuvctDs2Ow0tEJXvhrnzhvGYDF7Oiiw,3669
 psdi_data_conversion/static/content/convertc2x.htm,sha256=mqMscskUPS1JtV1ABl91kH_JyCmK7ORFjD1n2_MZFz4,3669
-psdi_data_conversion/static/content/documentation.htm,sha256=1GiEjlDCP0kJ3CKkx3l1gPxeOPp4bdOP95MPKx4dzvI,5557
 psdi_data_conversion/static/content/download.htm,sha256=DQKWEuq_Bjv2TyV6DnPXnHrSOBvGYRHOU-m6YOwfsh4,4727
 psdi_data_conversion/static/content/feedback.htm,sha256=fZrhn4Egs9g6ygqPzV6ZG9ndYK02VdALNVNXRsZ716k,1788
-psdi_data_conversion/static/content/header-links.html,sha256=7B2bHa7dLfSZ4hPMvVJ3kR0niVAOO3FtHJo0K6m1oP4,693
+psdi_data_conversion/static/content/header-links.html,sha256=DMELMnFgAuNz8XUt9P75Zn9qWz9bZyfIv4OVZRP86BY,699
 psdi_data_conversion/static/content/psdi-common-footer.html,sha256=3_KqTtwtkvCvi52LcRrN7oVfMfFdHqrHc39gMrYzGxg,4070
-psdi_data_conversion/static/content/psdi-common-header.html,sha256=2upXPOZ-EM6Bv7ltPJnynPBjYz4Z27sNl4LuUaVdVjM,1815
+psdi_data_conversion/static/content/psdi-common-header.html,sha256=daSpOs3x2bZnrIXcZm8HfRmclKeAKQiY6LLLCZCUOBY,1825
 psdi_data_conversion/static/content/report.htm,sha256=CRwlF7a7QvAjHsajuehWOtLxbo-JAjqrS_Q-I4BWxzs,4549
-psdi_data_conversion/static/content/index-versions/header-links.html,sha256=WN9oZL7hLtH_yv5PvX3Ky7_YGrNvQL_RQ5eU8DB50Rg,764
+psdi_data_conversion/static/content/index-versions/header-links.html,sha256=L3Bz1HzmdwkeCiOFITZWyXkPupYWtZVaZ06Vlxb0Mgw,751
 psdi_data_conversion/static/content/index-versions/psdi-common-footer.html,sha256=APBMI9c5-4fNV-CCYEs9ySgAahc7u1w-0e3EjM1MiD8,4126
-psdi_data_conversion/static/content/index-versions/psdi-common-header.html,sha256=w6Q_uu0W4MdioVoh6w0Cy4m2ACr7xAnampx1TfPvT9M,1897
+psdi_data_conversion/static/content/index-versions/psdi-common-header.html,sha256=deLfs9orJk_snptS34Vgp3r0q37gItvcODOLpOqlEKQ,1888
 psdi_data_conversion/static/data/data.json,sha256=1nljosxtwbLRfIIIa6-GHJnhvzhB759oEGvVQ18QP_4,3647095
 psdi_data_conversion/static/img/colormode-toggle-dm.svg,sha256=Q85ODwU67chZ77lyT9gITtnmqzJEycFmz35dJuqaPXE,502
 psdi_data_conversion/static/img/colormode-toggle-lm.svg,sha256=sIKXsNmLIXU4fSuuqrN0r-J4Hd3NIqoiXNT3mdq5-Fo,1155
@@ -72,17 +71,18 @@ psdi_data_conversion/static/javascript/format.js,sha256=S-ovNuqOSfS-RYDhFxxCDpTK
 psdi_data_conversion/static/javascript/load_accessibility.js,sha256=jTLfmubEmko2bJ_MKWMkmYxUeBxotozc-0-ua69CYJo,3265
 psdi_data_conversion/static/javascript/psdi-common.js,sha256=I0QqGQ7l_rA4KEfenQTfPc-uOXXp8sxMh_NHL3EkFm4,6231
 psdi_data_conversion/static/javascript/report.js,sha256=BHH5UOhXJtB6J_xk_y6woquNKt5W9hCrQapxKtGG1eA,12470
-psdi_data_conversion/static/styles/format.css,sha256=PaQkUVxQfXI9nbJ-7YsN1tNIcLXfwXk8wJC-zht8nRA,3269
-psdi_data_conversion/static/styles/psdi-common.css,sha256=09VY-lldoZCrohuqPKnd9fvDget5g9ybi6uh13pYeY0,17249
-psdi_data_conversion/templates/index.htm,sha256=Y1KlrBirqDPyleVl_Edgbm_jYMBYGnOEMdCzmDBJi3o,6842
+psdi_data_conversion/static/styles/format.css,sha256=v4kppsPEigK76bjkrL1r_5fA5350dtj3OQh4qzY27rc,3269
+psdi_data_conversion/static/styles/psdi-common.css,sha256=w6WMKL4oeAQDQlwZOr-K-F3OXUXLbcjvmSGWqIT5Lj4,17378
+psdi_data_conversion/templates/documentation.htm,sha256=thLOvEW4crVlqgydiOvP-Oiq8o7KtAsC1oqR6ltGDDs,7192
+psdi_data_conversion/templates/index.htm,sha256=YM4iXC_4ARj-VfPVxVrfW1SI3WacqO-p5T-ohysR0FA,6833
 psdi_data_conversion/testing/__init__.py,sha256=Xku7drtLTYLLPsd403eC0LIEa_iohVifyeyAITy2w7U,135
 psdi_data_conversion/testing/constants.py,sha256=BtIafruSobZ9cFY0VW5Bu209eiftnN8b3ObouZBrFQU,521
 psdi_data_conversion/testing/conversion_callbacks.py,sha256=ATR-_BsYCUN8KyOyUjfdWCELzySxLN5jOI0JyrQnmHQ,18858
 psdi_data_conversion/testing/conversion_test_specs.py,sha256=8W97tI6dVbHE9BEW76dsKDlfsm5oTlrlntG--b0h8HU,26106
 psdi_data_conversion/testing/gui.py,sha256=ul7ixYANIzmOG2ZNOZmQO6wsHmGHdiBGAlw-KuoN0j8,19085
 psdi_data_conversion/testing/utils.py,sha256=YrFxjyiIx1seph0j7jCUgAVm6HvXY9QJjx0MvNJRbfw,26134
-psdi_data_conversion-0.1.5.dist-info/METADATA,sha256=3Fy5AInPWk3jV52-lsTcSvmJdBicl9npSOrrDch-m0w,48108
-psdi_data_conversion-0.1.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-psdi_data_conversion-0.1.5.dist-info/entry_points.txt,sha256=xL7XTzaPRr2E67WhOD1M1Q-76hB8ausQlnNiHzuZQPA,123
-psdi_data_conversion-0.1.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-psdi_data_conversion-0.1.5.dist-info/RECORD,,
+psdi_data_conversion-0.1.7.dist-info/METADATA,sha256=apoqhRWCzkWMbXnZvyxcmU1L4pY-sLp0BPNAVTOVGzo,48380
+psdi_data_conversion-0.1.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+psdi_data_conversion-0.1.7.dist-info/entry_points.txt,sha256=xL7XTzaPRr2E67WhOD1M1Q-76hB8ausQlnNiHzuZQPA,123
+psdi_data_conversion-0.1.7.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+psdi_data_conversion-0.1.7.dist-info/RECORD,,