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.0.3.tar.gz (64.4 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.0.3-py3-none-any.whl (56.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for openaq-1.0.3.tar.gz
Algorithm Hash digest
SHA256 0c609db57f333cd889abb3372de604688f077d8d79ad3aa3de3c5701549a26d6
MD5 7b6283680fe9e76637f166360b3d4341
BLAKE2b-256 b462d799c54bfb5cee251a7c66ed97c6f3d4052a46f9076d26ae4edaa101d098

See more details on using hashes here.

File details

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

File metadata

  • Download URL: openaq-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 56.1 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.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 79abf724790c8164af7a6ceab9b85678b7c4019ead6330856818a0f8efc21e7d
MD5 ee283a6db42bfd43ae34f819536c2f61
BLAKE2b-256 18f941e399250a21e0ca8b4583c09795773e6957bdc1d1230f855e7fd049c873

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