/openaq-python

Official OpenAQ Python SDK

Primary LanguagePythonMIT LicenseMIT

openaq-python

The official Python SDK for the OpenAQ API.

⚠️ OpenAQ python is still under active development and may be unstable until a v1.0.0 release

Python SDK for the OpenAQ Version 3 API.

PyPI - Version PyPI - Python Version

Table of Contents

Installation

OpenAQ python is availble on pip.

pip install openaq

Documentation

Documentation available at python.openaq.org

Documentation can also be run locally using hatch run docs:serve

License

openaq is distributed under the terms of the MIT license.

Development

Code is styled according to black, imports are sorted using isort, and code is linted using ruff.

Codebase can be automatically formatted and linted by running:

hatch run style:fmt

style can be checked with:

hatch run style:check

Testing uses pytest.

hatch run test:test

Code coverage can be viewed with:

hatch run test:cov

Acknowledgements

For many years py-openaq by David Hagan filled the gap for a Python API SDK for the OpenAQ API. Thank you to David for many years of maintaining py-openaq and for taking the original step to develop a Python tool for OpenAQ.