Skip to main content

OpenAQ Python SDK

The official Python SDK for the OpenAQ API.

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


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.

Metadata

Release files for openaq 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openaq 1.2.0
File Size Uploaded Provenance Actions
openaq-1.2.0.tar.gz 193.1 kB Without provenance Details for openaq-1.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for openaq 1.2.0
File Interpreter ABI Platform Actions
openaq-1.2.0-py3-none-any.whl Python 3 none any Details for openaq-1.2.0-py3-none-any.whl

Total release size: 246.0 kB

Release files / openaq-1.2.0.tar.gz

Download URL openaq-1.2.0.tar.gz
Size 193.1 kB
Tags Source
SHA-256 checksum
How to use checksums
b5925322f196f89e77e5c4a26031c2dcae8f1544128eb59b724ee364a5d19978
BLAKE2b-256 checksum
How to use checksums
b2c7ae7d05c6a01499cdc2e013006c46007a1a97fca703065d2623202974c5ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Release files / openaq-1.2.0-py3-none-any.whl

Download URL openaq-1.2.0-py3-none-any.whl
Size 52.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e295fe8716c2424d2282c5a2e7db131f23c6ed7e2b68b880d2ba37334ff53ee0
BLAKE2b-256 checksum
How to use checksums
dda1c0545f2634575feb2c12f5d348c52f020f7e084a6d5ca4ebb3562dabdbc2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Security for openaq 1.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page