Skip to content
Python wrapper for the Open AQ API
Python Shell
Branch: master
Clone or download
dhhagan Merge pull request #30 from stijnvanhoey/patch-1
Add requests package  as dependency
Latest commit a0c3ee0 Jun 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs track build dir Jan 24, 2018
examples finished prepping doc deployment Jan 24, 2018
openaq fixed merge issues Jan 24, 2018
tests fixed merge issues Jan 24, 2018
.gitignore
.travis.yml got rid of testing for everything except 2.7 and 3.5 because it was m… Dec 24, 2016
LICENSE
README.md updated readme Jan 24, 2018
deploy.sh
setup.cfg
setup.py Add requests package as dependency Jun 21, 2019

README.md

Build Status PyPI version Coverage Status

py-openaq

This project contains the python wrapper for the Open AQ API.

Full documentation can be found here!

Installation

pip install py-openaq

Contributing to Development

Generating Documentation

Documentation is generated using sphinx and auto-doc. Please see their respective documents for help. Docs are automatically built for each new release, but you can build them locally by navigating to the /docs directory and then issuing the following commands:

>>> make clean
>>> make notebooks
>>> make html

You can then go ahead and navigate to the /docs/_build/html directory and open them up by clicking on index.html. There is a brief explanation on how to better contribute to docs, which can be found in the README.md file within the docs/ directory!

Suggestions

If there is a feature you would like to see added, please submit as an Issue. Feel free to send pull requests if you are comfortable, otherwise another developer will try to reply to any issue requests.

Running Tests Locally

To run the tests locally:

python setup.py test

To run the tests locally with coverage:

coverage run --source openaq setup.py test

# View the report
coverage report -m

Quickstart

import openaq

api = openaq.OpenAQ()

status, resp = api.cities()
You can’t perform that action at this time.