Feature/final prep work for v1.2.0 release (#51)

* Sphinx Docs

-- updated shpinx docs
-- bumped version to V1.2.0

* Update README.md

-- updated descriptions for Data Loggers

* Update README.md

-- added the PAA_GROUP_SENSOR_REQUEST_JSON_FILE section

-- added links to example json files

* Update README.md

-- few final tweaks to read me file

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: cf4260bdf806c6a7bfbde988293102d0
+config: e4e9bcf17f6cd2e8420e65f9ddcadf9d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/PurpleAirCSVDataLogger.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirCSVDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirCSVDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -97,7 +97,7 @@
 single request rather than individual requests in succession.”</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="PurpleAirCSVDataLogger.PurpleAirCSVDataLogger">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirCSVDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirCSVDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_to_save_csv_files_in</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirCSVDataLogger.PurpleAirCSVDataLogger" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirCSVDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirCSVDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIWriteKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_to_save_csv_files_in</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirCSVDataLogger.PurpleAirCSVDataLogger" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PurpleAirDataLogger</span></code></p>
 <p>The logger class. For now we will insert data into a CSV file.</p>
 <dl class="py method">

docs/html/PurpleAirCSVDataLoggerConstants.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirCSVDataLoggerConstants module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirCSVDataLoggerConstants module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/PurpleAirDataLogger.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -94,11 +94,11 @@
 A python base Data Logger class.</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="PurpleAirDataLogger.PurpleAirDataLogger">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirDataLogger.PurpleAirDataLogger" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIWriteKey</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirDataLogger.PurpleAirDataLogger" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>The Base Data Logger class. Will define common methods used by other data loggers. For
-example, PSQLDataLogger and CSVDataLogger. Inheritors of this class will only need to define
-their own ‘store_sensor_data’ method.</p>
+example, PSQLDataLogger, CSVDataLogger, or SQLiteDataLogger. Inheritors of this class
+will only need to define their own ‘store_sensor_data’ method.</p>
 <dl class="py property">
 <dt class="sig sig-object py" id="PurpleAirDataLogger.PurpleAirDataLogger.send_request_every_x_seconds">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send_request_every_x_seconds</span></span><a class="headerlink" href="#PurpleAirDataLogger.PurpleAirDataLogger.send_request_every_x_seconds" title="Permalink to this definition"></a></dt>

docs/html/PurpleAirPSQLDataLogger.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirPSQLDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirPSQLDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -98,7 +98,7 @@
 single request rather than individual requests in succession.”</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="PurpleAirPSQLDataLogger.PurpleAirPSQLDataLogger">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirPSQLDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirPSQLDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">psql_db_conn</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirPSQLDataLogger.PurpleAirPSQLDataLogger" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirPSQLDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirPSQLDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIWriteKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">psql_db_conn</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirPSQLDataLogger.PurpleAirPSQLDataLogger" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PurpleAirDataLogger</span></code></p>
 <p>The logger class. For now we will ingest data into a TimeScaleDB PostgreSQL
 database. Then we will use Grafana to visualize said data.</p>

docs/html/PurpleAirPSQLQueryStatements.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirPSQLQueryStatements module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirPSQLQueryStatements module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/PurpleAirSQLiteDataLogger.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirSQLiteDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirSQLiteDataLogger module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -97,7 +97,7 @@
 single request rather than individual requests in succession.”</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="PurpleAirSQLiteDataLogger.PurpleAirSQLiteDataLogger">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirSQLiteDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirSQLiteDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sqlite_data_base_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirSQLiteDataLogger.PurpleAirSQLiteDataLogger" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirSQLiteDataLogger.</span></span><span class="sig-name descname"><span class="pre">PurpleAirSQLiteDataLogger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIReadKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">PurpleAirAPIWriteKey</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sqlite_data_base_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirSQLiteDataLogger.PurpleAirSQLiteDataLogger" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PurpleAirDataLogger</span></code></p>
 <p>The logger class. For now we will insert data into a SQLite3 database file.</p>
 <dl class="py method">

docs/html/PurpleAirSQLiteQueryStatements.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirSQLiteQueryStatements module &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>PurpleAirSQLiteQueryStatements module &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'V1.2.0a2',
+    VERSION: 'V1.2.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

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.2.0a2 documentation</title>
+  <title>Index &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/index.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <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.2.0a2 documentation</title>
+  <title>Welcome to PurpleAir Data Logger(s)’s documentation! &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/modules.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>purpleair_data_logger &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>purpleair_data_logger &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/py-modindex.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>Python Module Index &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>

docs/html/search.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; PurpleAir Data Logger(s) V1.2.0a2 documentation</title>
+  <title>Search &mdash; PurpleAir Data Logger(s) V1.2.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 

setup.py

@@ -12,7 +12,7 @@ def read_file(filename):
 
 setup(
     name="purpleair_data_logger",
-    version="1.2.0a3",
+    version="1.2.0",
     license="MIT",
     author="Carlos Santos",
     author_email="[email protected]",

sphinx_docs_build/source/conf.py

@@ -23,7 +23,7 @@
 author = "carlkid1499"
 
 # The full version, including alpha/beta/rc tags
-release = "V1.2.0a2"
+release = "V1.2.0"
 
 
 # -- General configuration ---------------------------------------------------