fix spelling issues, update ignored_wordlist.txt, add AQS_domain para…

…meter to helperfunctions.__aqs(), reformat code with black

docs/_build/html/py-modindex.html

@@ -91,7 +91,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="pyaqsapi.bybox.html#module-pyaqsapi.bybox.bybox"><code class="xref">pyaqsapi.bybox.bybox</code></a></td><td>
+       <a href="pyaqsapi.html#module-pyaqsapi.bybox.bybox"><code class="xref">pyaqsapi.bybox.bybox</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -101,7 +101,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="pyaqsapi.bycbsa.html#module-pyaqsapi.bycbsa.bycbsa"><code class="xref">pyaqsapi.bycbsa.bycbsa</code></a></td><td>
+       <a href="pyaqsapi.html#module-pyaqsapi.bycbsa.bycbsa"><code class="xref">pyaqsapi.bycbsa.bycbsa</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -111,7 +111,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="pyaqsapi.bycounty.html#module-pyaqsapi.bycounty.bycounty"><code class="xref">pyaqsapi.bycounty.bycounty</code></a></td><td>
+       <a href="pyaqsapi.html#module-pyaqsapi.bycounty.bycounty"><code class="xref">pyaqsapi.bycounty.bycounty</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -121,7 +121,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="pyaqsapi.byma.html#module-pyaqsapi.byma.byma"><code class="xref">pyaqsapi.byma.byma</code></a></td><td>
+       <a href="pyaqsapi.html#module-pyaqsapi.byma.byma"><code class="xref">pyaqsapi.byma.byma</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -131,7 +131,7 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="pyaqsapi.bypqao.html#module-pyaqsapi.bypqao.bypqao"><code class="xref">pyaqsapi.bypqao.bypqao</code></a></td><td>
+       <a href="pyaqsapi.html#module-pyaqsapi.bypqao.bypqao"><code class="xref">pyaqsapi.bypqao.bypqao</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>

docs/ignored_wordlist.txt

@@ -34,19 +34,22 @@ metadatafunctions
 minlat
 minlon
 parameterclass
+parameterclasses
 pqao
 pqaos
 pyaqsapi
 qa
 qc
 quarterly
+quarterlysummary
 sampledata
 sampleduration
 sampledurations
 setupfunctions
 sitenum
 stateFIPS
 submodules
+timeframe
 th
 transactionsample
 Truro

pyaqsapi/bybox/tests/test_bybox.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user

pyaqsapi/bycbsa/tests/test_bycbsa.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user

pyaqsapi/bycounty/tests/test_bycounty.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user

pyaqsapi/byma/tests/test_byma.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user

pyaqsapi/bypqao/tests/test_bypqao.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user

pyaqsapi/bysite/bysite.py

@@ -432,8 +432,8 @@ def sampledata(
 
     Returns
     -------
-    (pandas DataFrame or an AQSAPI_V2 object): sample data aggregagted at the
-    site level matching the input stateFIPS, countycode and sitenumb
+    (pandas DataFrame or an AQSAPI_V2 object): sample data aggregated at the
+    site level matching the input stateFIPS, countycode and sitenum
     for the time frame between bdate and edate.
     """
     service = "sampleData"
@@ -1587,7 +1587,7 @@ def qa_pep_audit(
     Returns
     -------
     (pandas DataFrame or an AQSAPI_V2 object): quality assurance
-    PEP audit data within a stateFIPS, countycode and sitenumb
+    PEP audit data within a stateFIPS, countycode and sitenum
     for the time frame between bdate and edate.
     """
     service = "qaPepAudits"

pyaqsapi/bysite/tests/test_bysite.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user

pyaqsapi/bystate/bystate.py

@@ -6,7 +6,13 @@
 
 
 def monitors(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a table of monitors.
@@ -82,7 +88,13 @@ def monitors(
 
 
 def qa_flowrateaudit(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return Quality assurance flowrate audit data.
@@ -162,7 +174,13 @@ def qa_flowrateaudit(
 
 
 def qa_one_point_qc(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a DataFrame or an AQS_Data Mart_APIv2 S3 object containing Quality
@@ -237,7 +255,13 @@ def qa_one_point_qc(
 
 
 def qa_pep_audit(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a table of Performance Evaluation Program (PEP) audit data
@@ -401,7 +425,13 @@ def sampledata(
 
 
 def annualsummary(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a DataFrame of annual data aggregated at the state level.
@@ -478,7 +508,13 @@ def annualsummary(
 
 
 def qa_blanks(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a table of blank quality assurance data. Blanks are unexposed
@@ -556,7 +592,13 @@ def qa_blanks(
 
 
 def dailysummary(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a DataFrame of data aggregated at the state level.
@@ -633,7 +675,13 @@ def dailysummary(
 
 
 def qa_collocated_assessments(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a table of collocated assessment data aggregated by matching input
@@ -711,7 +759,13 @@ def qa_collocated_assessments(
 
 
 def qa_flowrateverification(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a table containing flow rate Verification data for a parameter code
@@ -790,7 +844,13 @@ def qa_flowrateverification(
 
 
 def transactionsample(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return transactionsample data - aggregated by state in the AQS Submission
@@ -871,7 +931,13 @@ def transactionsample(
 
 
 def qa_annualperformanceeval(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return quality assurance performance evaluation data - aggregated by
@@ -926,7 +992,7 @@ def qa_annualperformanceeval(
     -------
     (pandas DataFrame or an AQSAPI_V2 object): quality assurance
     performance evaluation data for all monitoring sites for the
-    matching parametercode and stateFIPS requested for the time frame
+    matching parameter and stateFIPS requested for the time frame
     between bdate and edate.
     """
     service = "qaAnnualPerformanceEvaluations"
@@ -952,7 +1018,13 @@ def qa_annualperformanceeval(
 
 
 def qa_annualperformanceevaltransaction(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return AQS submissions transaction format (RD) of the annual
@@ -1009,7 +1081,7 @@ def qa_annualperformanceevaltransaction(
     -------
     (pandas DataFrame or an AQSAPI_V2 object): quality assurance
     performance evaluation data. for all monitoring sites with matching
-    parametercode and stateFIPS requested for the time frame
+    parameter and stateFIPS requested for the time frame
     between bdate and edate.
     """
     service = "transactionsQaAnnualPerformanceEvaluations"
@@ -1035,7 +1107,13 @@ def qa_annualperformanceevaltransaction(
 
 
 def quarterlysummary(
-    parameter, bdate, edate, stateFIPS, cbdate=None, cedate=None, return_header=False
+    parameter,
+    bdate,
+    edate,
+    stateFIPS,
+    cbdate=None,
+    cedate=None,
+    return_header=False,
 ):
     """
     Return a DataFrame of quarterly data aggregated at the state level.

pyaqsapi/bystate/tests/test_bystate.py

@@ -11,7 +11,7 @@
 
 @pytest.fixture
 def setuppyaqsapi(autouse=True):
-    if exists(".\\dev\\local.py"):
+    if exists("./dev/local.py"):
         # the following should only execute if the file ./dev/local.py exists
         # under the project root folder. This file should not exist on the git
         # repostiory or in the final package. local looads the AQS user