https://github.com/dhhagan/py-openaq

Python wrapper for the Open AQ API
https://github.com/dhhagan/py-openaq

Last synced: 13 days ago
JSON representation

Python wrapper for the Open AQ API

• Host: GitHub
• URL: https://github.com/dhhagan/py-openaq
• Owner: dhhagan
• License: mit
• Created: 2015-12-18T14:20:11.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-01-31T17:02:52.000Z (almost 3 years ago)
• Last Synced: 2024-10-12T16:38:16.330Z (27 days ago)
• Language: Python
• Size: 6.59 MB
• Stars: 63
• Watchers: 8
• Forks: 10
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-air-quality - py-openaq - _python wrapper for the OpenAQ API_ (Software Libraries)

README

        
[![Build Status](https://travis-ci.org/dhhagan/py-openaq.svg?branch=master)](https://travis-ci.org/dhhagan/py-openaq)

[![PyPI version](https://badge.fury.io/py/py-openaq.svg)](https://badge.fury.io/py/py-openaq)

[![Coverage Status](https://coveralls.io/repos/dhhagan/py-openaq/badge.svg?branch=master&service=github)](https://coveralls.io/github/dhhagan/py-openaq?branch=master)

# py-openaq

This project contains the python wrapper for the [Open AQ API][1].

Full documentation can be found [here][2]!

## Installation

    pip install py-openaq

## Contributing to Development

### Generating Documentation

Documentation is generated using [sphinx][3] and [auto-doc][4]. 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][5].

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()

[1]: https://docs.openaq.org/

[2]: http://dhhagan.github.io/py-openaq/index.html

[3]: http://www.sphinx-doc.org/en/stable/

[4]: http://www.sphinx-doc.org/en/stable/ext/autodoc.html

[5]: https://github.com/dhhagan/py-openaq/issues/new