Prep Work (#74)

- prep work for V1.3.0
carlkidcrypto · Dec 13, 2023 · 940e449 · 940e449
1 parent d900a3f
commit 940e449
Show file tree

Hide file tree

Showing 30 changed files with 128 additions and 88 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 carlkidcrypto
+Copyright (c) 2023 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: 8e8a1e6ee8ef18077e8ca108d99e283e
+config: 0b1b98e3b37c52bd7574e3f8e7b12205
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/PurpleAirCSVDataLogger.html b/docs/html/PurpleAirCSVDataLogger.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirCSVDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/PurpleAirCSVDataLoggerConstants.html b/docs/html/PurpleAirCSVDataLoggerConstants.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirCSVDataLoggerConstants module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/PurpleAirDataLogger.html b/docs/html/PurpleAirDataLogger.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/PurpleAirDataLoggerHelpers.html b/docs/html/PurpleAirDataLoggerHelpers.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirDataLoggerHelpers module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>
@@ -105,8 +107,10 @@
 <dd class="field-odd"><p><strong>raw_data</strong> (<em>dict</em>) – The return value from either padl_obj.request_members_data or
 padl_obj.request_multiple_sensors_data.</p>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A list full of the dict data type that the store_sensor_data method expects.</p>
+</dd>
 </dl>
-<p>:return A list full of the dict data type that the store_sensor_data method expects.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -117,8 +121,10 @@
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>raw_data</strong> (<em>dict</em>) – The return value from padl_obj.request_sensor_data.</p>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>A single level dict full request_sensor_data data.</p>
+</dd>
 </dl>
-<p>:return A single level dict full request_sensor_data data.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -129,8 +135,10 @@
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>argparse_description</strong> (<em>str</em>) – A description for the argument parser that will be return</p>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>An instance of argparse with the common arguments added.</p>
+</dd>
 </dl>
-<p>:return An instance of argparse with the common arguments added.</p>
 </dd></dl>
 
 <dl class="py function">
@@ -145,8 +153,10 @@
 <li><p><strong>json_config_file</strong> (<em>dict</em>) – A dictionary object of the json config file using json load.</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The group_id int</p>
+</dd>
 </dl>
-<p>:return The group_id int</p>
 </dd></dl>
 
 <dl class="py function">
@@ -160,8 +170,10 @@
 <li><p><strong>json_config_file</strong> (<em>dict</em>) – A dictionary object of the json config file using json load.</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
 </dl>
-<p>:return None</p>
 </dd></dl>
 
 <dl class="py function">
@@ -175,8 +187,10 @@
 <li><p><strong>json_config_file</strong> (<em>dict</em>) – A dictionary object of the json config file using json load.</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
 </dl>
-<p>:return None</p>
 </dd></dl>
 
 <dl class="py function">
@@ -190,8 +204,10 @@
 <li><p><strong>json_config_file</strong> (<em>dict</em>) – A dictionary object of the json config file using json load.</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
 </dl>
-<p>:return None</p>
 </dd></dl>
 
 <dl class="py function">

diff --git a/docs/html/PurpleAirPSQLDataLogger.html b/docs/html/PurpleAirPSQLDataLogger.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirPSQLDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/PurpleAirPSQLQueryStatements.html b/docs/html/PurpleAirPSQLQueryStatements.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirPSQLQueryStatements module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/PurpleAirSQLiteDataLogger.html b/docs/html/PurpleAirSQLiteDataLogger.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirSQLiteDataLogger module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/PurpleAirSQLiteQueryStatements.html b/docs/html/PurpleAirSQLiteQueryStatements.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirSQLiteQueryStatements module &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

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.0a1',
+    VERSION: 'V1.3.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -1,18 +1,20 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <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.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>Index &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>

diff --git a/docs/html/index.html b/docs/html/index.html
@@ -1,19 +1,21 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <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>Welcome to PurpleAir Data Logger(s)’s documentation! &mdash; PurpleAir Data Logger(s) V1.3.0a1 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>Welcome to PurpleAir Data Logger(s)’s documentation! &mdash; PurpleAir Data Logger(s) V1.3.0 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" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
         <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=c3a4fe22"></script>
+        <script src="_static/documentation_options.js?v=6057c3a4"></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>