release/v1.3.2 (#84)

* Workflows - updated workflows to run when files change. * Update tests.yml - fixing the test. * Sphinx - updating sphinx docs.
carlkidcrypto · Jan 6, 2024 · 6c08ac8 · 6c08ac8
1 parent e28c76e
commit 6c08ac8
Show file tree

Hide file tree

Showing 32 changed files with 116 additions and 53 deletions.
diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml
@@ -8,8 +8,29 @@ on:
     branches: [ main ]
 
 jobs:
+  check-source-changes:
+    runs-on: ubuntu-latest
+    outputs:
+      run_job: ${{ steps.changed-files.outputs.any_changed }}
+    steps:
+      - name: Checkout Sourcecode
+        uses: actions/checkout@v4
+
+      - name: Check for changes in source code
+        id: changed-files
+        uses: tj-actions/[email protected]
+        with:
+          files: |
+            purpleair_api/*.py
+            tests/*.py
+            tests/*.txt
+            setup.py
+            setup.cfg
+
   black:
     runs-on: ubuntu-latest
+    needs: check-source-changes
+    if: needs.check-source-changes.outputs.run_job == 'true'
     steps:
       - uses: actions/checkout@v4
       - uses: psf/[email protected]
diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml
@@ -8,8 +8,27 @@ on:
     branches: [ main ]
 
 jobs:
+  check-source-changes:
+    runs-on: ubuntu-latest
+    outputs:
+      run_job: ${{ steps.changed-files.outputs.any_changed }}
+    steps:
+      - name: Checkout Sourcecode
+        uses: actions/checkout@v4
+
+      - name: Check for changes in source code
+        id: changed-files
+        uses: tj-actions/[email protected]
+        with:
+          files: |
+            sphinx_docs_build/source/*.rst
+            sphinx_docs_build/source/*.py
+            sphinx_docs_build/*.txt
+
   sphinx_docs_build:
     runs-on: ubuntu-latest
+    needs: check-source-changes
+    if: needs.check-source-changes.outputs.run_job == 'true'
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
@@ -19,21 +38,23 @@ jobs:
         with:
           python-version: "3.10"
 
-      - name: Install python3 requirements...
+      - name: Install python3/os requirements...
         uses: carlkidcrypto/[email protected]
         with:
           linux: cd /home/runner/work/purpleair_data_logger/purpleair_data_logger/ &&
-                  python -m pip install --upgrade wheel &&
-                  python -m pip install --upgrade setuptools &&
-                  python -m pip install --upgrade pip &&
-                  python -m pip install -r sphinx_docs_build/requirements.txt &&
-                  python -m pip install . --user
+                 python -m pip install --upgrade wheel &&
+                 python -m pip install --upgrade setuptools &&
+                 python -m pip install --upgrade pip &&
+                 python -m pip install -r sphinx_docs_build/requirements.txt &&
+                 python -m pip install . --user;
 
       - name: Run sphinx...
         uses: carlkidcrypto/[email protected]
         with:
-          linux: cd /home/runner/work/purpleair_data_logger/purpleair_data_logger/sphinx_docs_build ;
-                 make html
+          linux: cd /home/runner/work/purpleair_data_logger/purpleair_data_logger/sphinx_docs_build;
+                 mkdir source/_static;
+                 mkdir source/_templates;
+                 make clean && make html SPHINXOPTS="-W"
 
       - uses: actions/upload-artifact@v4
         with:

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -8,9 +8,30 @@ on:
     branches: [ main ]
 
 jobs:
+  check-source-changes:
+    runs-on: ubuntu-latest
+    outputs:
+      run_job: ${{ steps.changed-files.outputs.any_changed }}
+    steps:
+      - name: Checkout Sourcecode
+        uses: actions/checkout@v4
+
+      - name: Check for changes in source code
+        id: changed-files
+        uses: tj-actions/[email protected]
+        with:
+          files: |
+            purpleair_api/*.py
+            tests/*.py
+            tests/*.txt
+            setup.py
+            setup.cfg
+
   Unit_Tests:
     name: ${{ matrix.os }} using Python ${{ matrix.python-version }}
     runs-on: ${{ matrix.os }}
+    needs: check-source-changes
+    if: needs.check-source-changes.outputs.run_job == 'true'
     strategy:
       fail-fast: false
       matrix:

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 carlkidcrypto
+Copyright (c) 2024 carlkidcrypto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/doctrees/PurpleAirCSVDataLogger.doctree b/docs/doctrees/PurpleAirCSVDataLogger.doctree
diff --git a/docs/doctrees/PurpleAirCSVDataLoggerConstants.doctree b/docs/doctrees/PurpleAirCSVDataLoggerConstants.doctree
diff --git a/docs/doctrees/PurpleAirDataLogger.doctree b/docs/doctrees/PurpleAirDataLogger.doctree
diff --git a/docs/doctrees/PurpleAirDataLoggerHelpers.doctree b/docs/doctrees/PurpleAirDataLoggerHelpers.doctree
diff --git a/docs/doctrees/PurpleAirPSQLDataLogger.doctree b/docs/doctrees/PurpleAirPSQLDataLogger.doctree
diff --git a/docs/doctrees/PurpleAirPSQLQueryStatements.doctree b/docs/doctrees/PurpleAirPSQLQueryStatements.doctree
diff --git a/docs/doctrees/PurpleAirSQLiteDataLogger.doctree b/docs/doctrees/PurpleAirSQLiteDataLogger.doctree
diff --git a/docs/doctrees/PurpleAirSQLiteQueryStatements.doctree b/docs/doctrees/PurpleAirSQLiteQueryStatements.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/doctrees/modules.doctree b/docs/doctrees/modules.doctree
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0b1b98e3b37c52bd7574e3f8e7b12205
+config: d6e08cb550a57d43948f794f51590dcf
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/PurpleAirCSVDataLogger.html b/docs/html/PurpleAirCSVDataLogger.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirCSVDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirCSVDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -136,7 +136,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirCSVDataLoggerConstants.html b/docs/html/PurpleAirCSVDataLoggerConstants.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirCSVDataLoggerConstants module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirCSVDataLoggerConstants module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -229,7 +229,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirDataLogger.html b/docs/html/PurpleAirDataLogger.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -169,7 +169,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirDataLoggerHelpers.html b/docs/html/PurpleAirDataLoggerHelpers.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirDataLoggerHelpers module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirDataLoggerHelpers module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -236,7 +236,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirPSQLDataLogger.html b/docs/html/PurpleAirPSQLDataLogger.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirPSQLDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirPSQLDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -146,7 +146,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirPSQLQueryStatements.html b/docs/html/PurpleAirPSQLQueryStatements.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirPSQLQueryStatements module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirPSQLQueryStatements module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -276,7 +276,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirSQLiteDataLogger.html b/docs/html/PurpleAirSQLiteDataLogger.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirSQLiteDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirSQLiteDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -136,7 +136,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirSQLiteQueryStatements.html b/docs/html/PurpleAirSQLiteQueryStatements.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirSQLiteQueryStatements module &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>PurpleAirSQLiteQueryStatements module &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -15,7 +15,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -242,7 +242,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/_static/documentation_options.js b/docs/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'V1.3.0',
+    VERSION: 'V1.3.2',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; PurpleAir Data Logger(s) V1.3.0 documentation</title>
+  <title>Index &mdash; PurpleAir Data Logger(s) V1.3.2 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
 
         <script src="_static/jquery.js?v=5d32c60e"></script>
         <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-        <script src="_static/documentation_options.js?v=6057c3a4"></script>
+        <script src="_static/documentation_options.js?v=f3d7cdd7"></script>
         <script src="_static/doctools.js?v=888ff710"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -427,7 +427,7 @@ <h2 id="V">V</h2>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a