Prep for 1.2.0 (#100)

* Tests

- added a bit more cov
- updated version in setup, sphinx, and readme

* Docs

- sphinx docs
- diagrams
- copyrights

* Create requirements.txt

- adding a new req for the package

README.md

@@ -6,7 +6,7 @@ To use the PurpleAirAPI (PAA) api keys are required. You can get API keys by sen
 | [![PyPI Distributions](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_pypi.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_pypi.yml) | [![TestPyPI Distributions](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_test_pypi.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_test_pypi.yml) | [![Black](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/black.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/black.yml) |
 | --------------- | --------------- | --------------- |
 
-| [![Tests](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml) | [![total download count](https://img.shields.io/github/downloads/carlkidcrypto/purpleair_api/total.svg?style=flat-square&label=all%20downloads)](https://github.com/carlkidcrypto/purpleair_api/releases) | [![latest release download count](https://img.shields.io/github/downloads/carlkidcrypto/purpleair_api/v1.2.0a1/total.svg?style=flat-square)](https://github.com/carlkidcrypto/purpleair_api/releases/tag/v1.2.0a1) |
+| [![Tests](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml) | [![total download count](https://img.shields.io/github/downloads/carlkidcrypto/purpleair_api/total.svg?style=flat-square&label=all%20downloads)](https://github.com/carlkidcrypto/purpleair_api/releases) | [![latest release download count](https://img.shields.io/github/downloads/carlkidcrypto/purpleair_api/v1.2.0/total.svg?style=flat-square)](https://github.com/carlkidcrypto/purpleair_api/releases/tag/v1.2.0) |
 | --------------- | --------------- | --------------- |
 
 ## How to Support This Project

diagrams/README.md

@@ -2,8 +2,22 @@
 
 This directory contains design diagrams.
 
+## Dependencies
+
+Install
+
+```bash
+    python3 -m pip install pylint
+```
+
+On a Mac
+
+```bash
+    brew install Graphviz
+```
+
 ## Auto Generate UML
 
 ```bash
 pyreverse -d . -o png ../purpleair_api
-```
+```

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: c05b113e0dc9179f2ea0d12d4ea65d97
+config: 9255120cdb1a37b05236fb809758bc40
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/PurpleAirAPI.html

@@ -6,14 +6,14 @@
   <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>PurpleAirAPI module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirAPI module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -91,7 +91,7 @@
 
   <section id="module-PurpleAirAPI">
 <span id="purpleairapi-module"></span><h1>PurpleAirAPI module<a class="headerlink" href="#module-PurpleAirAPI" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>
 <dl class="py class">

docs/html/PurpleAirAPIConstants.html

@@ -6,14 +6,14 @@
   <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>PurpleAirAPIConstants module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirAPIConstants module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -89,7 +89,7 @@
 
   <section id="module-PurpleAirAPIConstants">
 <span id="purpleairapiconstants-module"></span><h1>PurpleAirAPIConstants module<a class="headerlink" href="#module-PurpleAirAPIConstants" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python with constants with for use in PurpleAirAPI.py</p>
 <dl class="py data">
 <dt class="sig sig-object py" id="PurpleAirAPIConstants.ACCEPTED_FIELD_NAMES_DICT">
@@ -101,7 +101,7 @@
 
 <dl class="py data">
 <dt class="sig sig-object py" id="PurpleAirAPIConstants.ERROR_CODES_LIST">
-<span class="sig-prename descclassname"><span class="pre">PurpleAirAPIConstants.</span></span><span class="sig-name descname"><span class="pre">ERROR_CODES_LIST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[400,</span> <span class="pre">403,</span> <span class="pre">404,</span> <span class="pre">409]</span></em><a class="headerlink" href="#PurpleAirAPIConstants.ERROR_CODES_LIST" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">PurpleAirAPIConstants.</span></span><span class="sig-name descname"><span class="pre">ERROR_CODES_LIST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">[400,</span> <span class="pre">402,</span> <span class="pre">403,</span> <span class="pre">404,</span> <span class="pre">409,</span> <span class="pre">415]</span></em><a class="headerlink" href="#PurpleAirAPIConstants.ERROR_CODES_LIST" title="Link to this definition"></a></dt>
 <dd><p>Accepted Error Codes</p>
 </dd></dl>
 

docs/html/PurpleAirAPIError.html

@@ -6,14 +6,14 @@
   <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>PurpleAirAPIError module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirAPIError module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -86,7 +86,7 @@
 
   <section id="module-PurpleAirAPIError">
 <span id="purpleairapierror-module"></span><h1>PurpleAirAPIError module<a class="headerlink" href="#module-PurpleAirAPIError" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>
 <dl class="py exception">

docs/html/PurpleAirAPIHelpers.html

@@ -6,14 +6,14 @@
   <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>PurpleAirAPIHelpers module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirAPIHelpers module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -92,7 +92,7 @@
 
   <section id="module-PurpleAirAPIHelpers">
 <span id="purpleairapihelpers-module"></span><h1>PurpleAirAPIHelpers module<a class="headerlink" href="#module-PurpleAirAPIHelpers" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python3 file containing helper functions for the PurpleAirAPI** files.
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>
 <dl class="py function">

docs/html/PurpleAirLocalAPI.html

@@ -6,14 +6,14 @@
   <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>PurpleAirLocalAPI module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirLocalAPI module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -89,7 +89,7 @@
 
   <section id="module-PurpleAirLocalAPI">
 <span id="purpleairlocalapi-module"></span><h1>PurpleAirLocalAPI module<a class="headerlink" href="#module-PurpleAirLocalAPI" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 This class will handle all <cite>local</cite> requests
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>

docs/html/PurpleAirReadAPI.html

@@ -6,14 +6,14 @@
   <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>PurpleAirReadAPI module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirReadAPI module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -97,7 +97,7 @@
 
   <section id="module-PurpleAirReadAPI">
 <span id="purpleairreadapi-module"></span><h1>PurpleAirReadAPI module<a class="headerlink" href="#module-PurpleAirReadAPI" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 This class will handle all <cite>read</cite> requests
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>

docs/html/PurpleAirWriteAPI.html

@@ -6,14 +6,14 @@
   <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>PurpleAirWriteAPI module &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>PurpleAirWriteAPI module &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -91,7 +91,7 @@
 
   <section id="module-PurpleAirWriteAPI">
 <span id="purpleairwriteapi-module"></span><h1>PurpleAirWriteAPI module<a class="headerlink" href="#module-PurpleAirWriteAPI" title="Link to this heading"></a></h1>
-<p>Copyright 2023 carlkidcrypto, All rights reserved.
+<p>Copyright 2024 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 This class will handle all <cite>write</cite> requests
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>

docs/html/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'V1.2.0a1',
+    VERSION: 'V1.2.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/html/genindex.html

@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>Index &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/html/index.html

@@ -6,14 +6,14 @@
   <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 PurpleAirAPI’s documentation! &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>Welcome to PurpleAirAPI’s documentation! &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/html/modules.html

@@ -6,14 +6,14 @@
   <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>purpleair_api &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>purpleair_api &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/html/py-modindex.html

@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>Python Module Index &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

docs/html/search.html

@@ -5,15 +5,15 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; PurpleAir API V1.2.0a1 documentation</title>
+  <title>Search &mdash; PurpleAir API V1.2.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=66b59bf7" />
 
 
 
       <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=3ed4c164"></script>
+      <script src="_static/documentation_options.js?v=118289fd"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>