I want to make it easy to get your hands on accurate air quality data for your project, whatever it is. Ozone makes this as straightforward as typing out a few lines of code. Ozone uses the World Air Quality Index's API to fetch data, so you can trust the data you get to be accurate and reliable. ✅ 📈

Install ozon3

Getting your API token

Getting started

Contributing and submitting PR's

Attributions

License and TOS

pip install ozon3

You can find more information on the PyPI page for Ozone here (called as Ozon3 on PyPI).

To use Ozone, you must first request and get a your own unique API token 🎫. This is required to access for the underlying API to work 👮🏼‍♂️.

This is very easy to do, and takes no time at all as your token is generally emailed to you instantly.

Get your token here!

import ozone as ooo

o3 = ooo.Ozone('YOUR_PRIVATE_TOKEN')
data = o3.get_city_air('CITY_NAME')

for many cities:

data = o3.get_multiple_city_air([ARRAY OF CITY NAMES])

We love PR's!

Take a look at the CONTRIBUTING.md file for details on how to go about this!

This package is a wrapper around an API provided by the World Air Quality Index project. Without them as well as the US EPA, Ozone would not exist. Please consider visiting the WAQI website and contributing to their project if you have time:

World Air Quality Index

United States Environmental Protection Agency

1. Ozone is licensed under the GNU GENERAL PUBLIC LICENSE v3.0, and so it cannot be used for closed-source software or for monetary gain.
2. The WAQI API, which Ozone usees to provide data, has it's own Acceptable Usage Policy. Please refer to it for more details.

Enjoy using Ozone! 🥳 🍾 🚀