Skip to content

Commit

Permalink
update meta.yml, spelling sphinxcontrib-spelling issues
Browse files Browse the repository at this point in the history
  • Loading branch information
mccroweyclinton-EPA committed Feb 5, 2024
1 parent 01a418b commit 5a7e9a3
Show file tree
Hide file tree
Showing 11 changed files with 87 additions and 59 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Introduction
============
The pyaqsapi module for the python 3 programming environment allows a python 3
programming environment to connect to and retrieve data from the United States
Environmental Protection Agency’s (US EPA) Air Quality System (AQS) Data Mart
Environmental Protection Agency\s (US EPA) Air Quality System (AQS) Data Mart
API v2 (Air Quality System)1 interface directly. This package enables the data
user to omit legacy challenges including coercing data from a JSON object to a
usable python 3 object, retrieving multiple years of data, formatting API
Expand Down Expand Up @@ -101,15 +101,15 @@ To install pyaqsapi first clone the pyaqsapi repository.
git clone https://github.com/USEPA/pyaqsapi.git
Next, in the project's root directory use pip to install the proper
Next, in the project\'s root directory use pip to install the proper
dependencies that are required to build
and install pyaqsapi.

.. code-block:: console
pip install -r requirements.txt
While still in the project's root directory use setuptools to build and pip
While still in the project\'s root directory use setuptools to build and pip
to install the package.

.. code-block:: console
Expand Down Expand Up @@ -165,7 +165,7 @@ authentication but only account monitoring. Each time pyaqsapi is loaded and
before using any of it’s functions use the aqs_credentials function to enter in
the user credentials so that pyaqsapi can access the AQS Data Mart server.

Both pyaqsapi and RAQSAPI use the US Environmental Protection Agency's Air
Both pyaqsapi and RAQSAPI use the US Environmental Protection Agency\'s Air
Quality Service DataMart to retrieve data. The same credentials can be used for
access to either project. Note however, that AQS and AQS DataMart are similar
and related data sources, however the credentials used to access AQS are not the
Expand Down
4 changes: 2 additions & 2 deletions __init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
pyaqsapi
--------
A python Interface to The United States Environmental Protection
Agency's Air Quality System Data Mart RESTful API server. pyaqsapi is a python
Agency\'s Air Quality System Data Mart RESTful API server. pyaqsapi is a python
port of RAQSAPI
pyaqsapi is a package for python that connects the python programming
environment to the United State's Environmental protection agency's
environment to the United States Environmental protection agency\'s
Air Quality System (AQS) Data Mart API for retrieval of air
monitoring data.
Expand Down
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
contain the root `toctree` directive.
.. sectionauthor:: Clinton Mccrowey <mccrowey <DOT> clinton <AT> epa.gov>
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

===========================
pyaqsapi user documentation
Expand Down
8 changes: 4 additions & 4 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1364,10 +1364,10 @@ <h3>pyaqsapi index<a class="headerlink" href="#pyaqsapi-index" title="Link to th
<h3>References<a class="headerlink" href="#references" title="Link to this heading"></a></h3>
<div class="docutils container" id="id6">
<ol class="arabic simple" start="1">
<li id="id10"><p>AQS DataMart welcome. Aug 2018. URL: <a class="reference external" href="https://aqs.epa.gov/aqsweb/documents/data_mart_welcome.html">https://aqs.epa.gov/aqsweb/documents/data_mart_welcome.html</a>.</p></li>
<li id="id8"><p>About AQS data. May 2019. Version 1.1. URL: <a class="reference external" href="https://aqs.epa.gov/aqsweb/documents/about_aqs_data.html">https://aqs.epa.gov/aqsweb/documents/about_aqs_data.html</a>.</p></li>
<li id="id12"><p>Pandas.Dataframe. January 2024. URL: <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html">https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html</a>.</p></li>
<li id="id11"><p>Clinton Mccrowey. A R extension to retrieve ambient air monitoring data from the United States Environmental Protection Agency’s (US EPA) Air Quality System (AQS) DataMart API V2 interface. 2022. URL: <a class="reference external" href="https://github.com/USEPA/RAQSAPI">https://github.com/USEPA/RAQSAPI</a>.</p></li>
<li id="id10"><p>Aqs datamart welcome. Aug 2018. URL: <a class="reference external" href="https://aqs.epa.gov/aqsweb/documents/data_mart_welcome.html">https://aqs.epa.gov/aqsweb/documents/data_mart_welcome.html</a>.</p></li>
<li id="id8"><p>About aqs data. May 2019. Version 1.1. URL: <a class="reference external" href="https://aqs.epa.gov/aqsweb/documents/about_aqs_data.html">https://aqs.epa.gov/aqsweb/documents/about_aqs_data.html</a>.</p></li>
<li id="id12"><p>Pandas dataframe. January 2024. URL: <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html">https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html</a>.</p></li>
<li id="id11"><p>Clinton Mccrowey. A r extension to retrieve ambient air monitoring data from the united states environmental protection agency's (us epa) air quality system (aqs) datamart api v2 interface. 2022. URL: <a class="reference external" href="https://github.com/USEPA/RAQSAPI">https://github.com/USEPA/RAQSAPI</a>.</p></li>
</ol>
</div>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/ignored_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ cedate
countycode
dailydata
dailysummary
dataframe
DataFrame
Datamart
durations
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
contain the root `toctree` directive.
.. sectionauthor:: Clinton Mccrowey <mccrowey <DOT> clinton <AT> epa.gov>
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

===========================
pyaqsapi user documentation
Expand Down
59 changes: 29 additions & 30 deletions docs/manual/pyaqsapi.bib
Original file line number Diff line number Diff line change
@@ -1,49 +1,48 @@
@online{cleanairact,
authors = "{US} {E}nvironmental {P}rotection {A}gency",
title = "Overview of the {C}lean {A}ir {A}ct and {A}ir {P}ollution",
month = "February",
year = "2021",
url = "https://www.epa.gov/clean-air-act-overview"
authors = {US Environmental Protection Agency},
title = {Overview of the Clean Air Act and Air Pollution},
month = {February},
year = {2021},
url = {https://www.epa.gov/clean-air-act-overview}
}

@online{AboutAQSdata,
authors = "{US} {EPA} {AQS} {D}ata{M}art Team",
title = "About {AQS} Data",
month = "May",
year = "2019",
url = "https://aqs.epa.gov/aqsweb/documents/about_aqs_data.html",
note = "Version 1.1"
authors = {US EPA AQS DataMart Team},
title = {About AQS Data},
month = {May},
year = {2019},
url = {https://aqs.epa.gov/aqsweb/documents/about_aqs_data.html},
note = {Version 1.1}
}

@online{website:GNUproject,
authors = "{F}ree {S}oftware {F}oundation",
title = "{GNU} Operating System",
month = "February",
year = "2020",
url = "https://www.gnu.org"
authors = {Free Software Foundation},
title = {GNU Operating System},
month = {February},
year = {2020},
url = {https://www.gnu.org}
}

@online{AQSDataMartWelcome,
authors = "{US} {EPA} {AQS} {D}ata{M}art Team",
title = "{AQS} {D}ata{M}art Welcome",
month = "Aug",
year = "2018",
url = "https://aqs.epa.gov/aqsweb/documents/data_mart_welcome.html"
authors = {US EPA AQS DataMart Team},
title = {AQS DataMart Welcome},
month = {Aug},
year = {2018},
url = {https://aqs.epa.gov/aqsweb/documents/data_mart_welcome.html}
}

@Misc{Rpackage:RAQSAPI,
title = "A {R} extension to retrieve ambient air monitoring data from
the {U}nited {S}tates {E}nvironmental {P}rotection {A}gency’s
({US EPA}) {A}ir
{Q}uality {S}ystem ({AQS}) {D}ata{M}art {API} {V}2 interface",
author = "{C}linton {M}ccrowey",
title = {A R extension to retrieve ambient air monitoring data from
the United States Environmental Protection Agency's
(US EPA) Air Quality System (AQS) DataMart API V2 interface},
author = {Clinton Mccrowey},
year = {2022},
url = {https://github.com/USEPA/RAQSAPI},
}

@online{pandas_DataFrame,
title = "pandas.{D}ataFrame",
month = "January",
year = "2024",
url = "https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html"
title = {pandas DataFrame},
month = {January},
year = {2024},
url = {https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html}
}
59 changes: 43 additions & 16 deletions meta.yaml
Original file line number Diff line number Diff line change
@@ -1,48 +1,75 @@
{% set version = '2.0.3' %}
{% set name = "pyaqsapi" %}
{% set version = '0.1a1.dev1' %}

{% set posix = 'm2-' if win else '' %}
{% set native = 'm2w64-' if win else '' %}

package:
name: pyaqsapi
version: 1.0.BETA
name: {{ name }}
version: {{ version }}

source:
fn: pyaqsapi-1.0.tar.gz
fn: dist/pyaqsapi-1.0b0.tar.gz

build:
noarch: python
number: 0
script: python -m pip install --no-deps --ignore-installed .
script: python -m pip install --no-deps --ignore-installed sphinxcontrib-bibtex.

requirements:
host:
- conda
- conda-build
- python
- python >=3.8
- pep517
- sphinx
- sphinx >=5.0
- sphinx_rtd_theme
- sphinxcontrib-napoleon
- sphinxcontrib-apidoc
- sphinxcontrib-bibtex
- toml
- wheel
- pip
- setuptools >=42
- codecov
- toml
- build

run:
- python
- python > = 3.8
- keyring
- pandas
- requests
- wheel
- pip
- certifi
- datetime
- cryptography
- numpydoc

test:
- python
test:
imports:
- pyaqsapi
commands:
- pip check
requires:
- python > = 3.8
- pytest
- pip
- sphinxcontrib-spelling
- tox
- pytest-black
- codecov
about:
home:"https://github.com/USEPA/pyaqsapi"
license: LICENSE.rst
summary: "Retrieve air monitoring data and associated metadata from the \
US Environmental Protection Agency's Air Quality System \
service using functions."
license: MIT
license_family: MIT
license_file: LICENSE.rst
summary: "Retrieve Ambient Air Monitoring data from US EPA AQS DataMart"
description: |
Retrieve air monitoring data and associated metadata from the
US Environmental Protection Agency's Air Quality System (AQS)
DataMart API service using python functions.
extra:
recipe-maintainers:
#GITHUB ID of the maintainer of pyaqsapi
- MCCROWEYCLINTON-EPA
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ sphinx>=5.0
#sphinxcontrib-napoleon
sphinxcontrib-apidoc
sphinxcontrib-spelling
sphinxcontrib-bibtex
datetime
toml
sphinx_rtd_theme
Expand Down

0 comments on commit 5a7e9a3

Please sign in to comment.