Skip to content

README.md

Latest commit

 

History

History
73 lines (48 loc) · 2.03 KB

README.md

File metadata and controls

73 lines (48 loc) · 2.03 KB
Raw

OpenAQ Python SDK

The official Python SDK for the OpenAQ API.

PyPI - Version PyPI - Python Version Codecov Static Badge Ruff slack

Table of Contents

Installation

The OpenAQ Python SDK is available on PyPI.

pip install openaq

Documentation

Documentation available at python.openaq.org

Information on building documentation site locally can be found in docs/README.md

License

The source code is distributed under the terms of the Apache 2.0 license.

Development

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

mypy static type checking:

hatch run types:check

Testing uses pytest.

hatch run test:test

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.