Skip to main content

Official OpenAQ Python SDK.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openaq-1.1.0.tar.gz (65.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openaq-1.1.0-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

Details for the file openaq-1.1.0.tar.gz.

File metadata

  • Download URL: openaq-1.1.0.tar.gz
  • Upload date:
  • Size: 65.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for openaq-1.1.0.tar.gz
Algorithm Hash digest
SHA256 23fcc189575cf0c5bfbbc99dafea1a38bdfd99ba6dcfbda61ce36ad850cebfd1
MD5 f66c62fac2f71f0c8e6a0df6ba2d08b3
BLAKE2b-256 91ddf1579644518f523cc2606f634867d8df0779316d0c2dbaf17dbd15f44a90

See more details on using hashes here.

File details

Details for the file openaq-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: openaq-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 56.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for openaq-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0e22bda05ce19f71c047a127506b2b8139e84c4443d53b2523b2eb320d36be8
MD5 9cb5fd5b68e35ae90cb195f31f0b2c5a
BLAKE2b-256 ae313c33c7f44a6a36a1a82537ed0d1845a518aaa72509b1f78d9a1eef56d470

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page