Skip to content

Commit

Permalink
Feature/9 local paa requests (#11)
Browse files Browse the repository at this point in the history
* Local PAA

- quick and dirty local paa requests

* Black

ran black

* Reorg

Making things more modular for easy of maintenance and writing tests.

* New Docs

ran sphinx again for new modules

* Index

Updated index page to point at the modules page.
  • Loading branch information
carlkidcrypto authored Jun 25, 2023
1 parent 80b866f commit e121fb6
Show file tree
Hide file tree
Showing 45 changed files with 2,365 additions and 1,265 deletions.
Binary file modified docs/doctrees/PurpleAirAPI.doctree
Binary file not shown.
Binary file added docs/doctrees/PurpleAirAPIError.doctree
Binary file not shown.
Binary file added docs/doctrees/PurpleAirAPIHelpers.doctree
Binary file not shown.
Binary file added docs/doctrees/PurpleAirLocalAPI.doctree
Binary file not shown.
Binary file added docs/doctrees/PurpleAirReadAPI.doctree
Binary file not shown.
Binary file added docs/doctrees/PurpleAirWriteAPI.doctree
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/modules.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: ec3e375d33d1f8ecd2ab218eab5dbe03
config: d4cf9a2ea15eadcbee49f7f6011bade5
tags: 645f666f9bcd5a90fca523b33c5a78b7
398 changes: 8 additions & 390 deletions docs/html/PurpleAirAPI.html

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion docs/html/PurpleAirAPIConstants.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>PurpleAirAPIConstants module &mdash; PurpleAir API V1.0.2 documentation</title>
<title>PurpleAirAPIConstants module &mdash; PurpleAir API V1.1.0a1 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]>
Expand All @@ -19,6 +19,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="PurpleAirAPIError module" href="PurpleAirAPIError.html" />
<link rel="prev" title="PurpleAirAPI module" href="PurpleAirAPI.html" />
</head>

Expand Down Expand Up @@ -52,6 +53,11 @@
<li class="toctree-l3"><a class="reference internal" href="#PurpleAirAPIConstants.SUCCESS_CODE_LIST"><code class="docutils literal notranslate"><span class="pre">SUCCESS_CODE_LIST</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirAPIError.html">PurpleAirAPIError module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirAPIHelpers.html">PurpleAirAPIHelpers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirLocalAPI.html">PurpleAirLocalAPI module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirReadAPI.html">PurpleAirReadAPI module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirWriteAPI.html">PurpleAirWriteAPI module</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -118,6 +124,7 @@
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="PurpleAirAPI.html" class="btn btn-neutral float-left" title="PurpleAirAPI module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PurpleAirAPIError.html" class="btn btn-neutral float-right" title="PurpleAirAPIError module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
132 changes: 132 additions & 0 deletions docs/html/PurpleAirAPIError.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>PurpleAirAPIError module &mdash; PurpleAir API V1.1.0a1 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]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="PurpleAirAPIHelpers module" href="PurpleAirAPIHelpers.html" />
<link rel="prev" title="PurpleAirAPIConstants module" href="PurpleAirAPIConstants.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html" class="icon icon-home">
PurpleAir API
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">purpleair_api</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="PurpleAirAPI.html">PurpleAirAPI module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirAPIConstants.html">PurpleAirAPIConstants module</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">PurpleAirAPIError module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#PurpleAirAPIError.PurpleAirAPIError"><code class="docutils literal notranslate"><span class="pre">PurpleAirAPIError</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirAPIHelpers.html">PurpleAirAPIHelpers module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirLocalAPI.html">PurpleAirLocalAPI module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirReadAPI.html">PurpleAirReadAPI module</a></li>
<li class="toctree-l2"><a class="reference internal" href="PurpleAirWriteAPI.html">PurpleAirWriteAPI module</a></li>
</ul>
</li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PurpleAir API</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">purpleair_api</a></li>
<li class="breadcrumb-item active">PurpleAirAPIError module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/PurpleAirAPIError.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="module-PurpleAirAPIError">
<span id="purpleairapierror-module"></span><h1>PurpleAirAPIError module<a class="headerlink" href="#module-PurpleAirAPIError" title="Permalink to this heading"></a></h1>
<p>Copyright 2023 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">
<dt class="sig sig-object py" id="PurpleAirAPIError.PurpleAirAPIError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirAPIError.</span></span><span class="sig-name descname"><span class="pre">PurpleAirAPIError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirAPIError.PurpleAirAPIError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Custom Exception for our PurpleAirAPI class.</p>
</dd></dl>

</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="PurpleAirAPIConstants.html" class="btn btn-neutral float-left" title="PurpleAirAPIConstants module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PurpleAirAPIHelpers.html" class="btn btn-neutral float-right" title="PurpleAirAPIHelpers module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023, carlkidcrypto.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit e121fb6

Please sign in to comment.