The official Python wrapper for the OpenAQ API.
⚠️ OpenAQ python is still under active development and may be unstable until a v1.0.0 release
OpenAQ Python is a low-level API wrapper for the OpenAQ Version 3 API.
Table of Contents
OpenAQ python is availble on pip.
pip install openaq
Documentation available at python.openaq.org
openaq
is distributed under the terms of the MIT license.
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
For many years py-openaq by David Hagan filled the gap for a Python API wrapper for the OpenAQ API. Thank you to David for this initial wrapper and maintaining it for so long.