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


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.1.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.1.0
File Size Uploaded
openaq-1.1.0.tar.gz 65.5 kB Details

Built distribution (wheel)

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

Total release size: 121.9 kB

Release files / openaq-1.1.0.tar.gz

Download URL openaq-1.1.0.tar.gz
Size 65.5 kB
Tags Source
SHA-256 checksum
How to use checksums
23fcc189575cf0c5bfbbc99dafea1a38bdfd99ba6dcfbda61ce36ad850cebfd1
BLAKE2b-256 checksum
How to use checksums
91ddf1579644518f523cc2606f634867d8df0779316d0c2dbaf17dbd15f44a90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

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

Download URL openaq-1.1.0-py3-none-any.whl
Size 56.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d0e22bda05ce19f71c047a127506b2b8139e84c4443d53b2523b2eb320d36be8
BLAKE2b-256 checksum
How to use checksums
ae313c33c7f44a6a36a1a82537ed0d1845a518aaa72509b1f78d9a1eef56d470
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.0

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.3

2 release files

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

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