A package to get air quality data using the WAQI API
Project description
Ozone ☁️
The simplest AQI API
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. ✅ 📈
You can view our complete documentation here
Table of Contents
Contributing and submitting PR's
Install it here!
pip install ozon3
You can find more information on the PyPI page for Ozone here (called ozon3 on PyPI).
Getting your API token
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!
Getting started 🏃♂️
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])
Examples In Action 🎬
Sample output:
Contributing and submitting Pull requests
We love PR's!
Take a look at the CONTRIBUTING.md file for details on how to go about this!
Semantic Versioning System
Ozone uses a semantic versioning system to increment its release version number. Using this model, changes in version numbers can help indicate the meaning of modified code for each version.
See more information on semantic versioning here.
World Air Quality Index and EPA attribution
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:
United States Environmental Protection Agency
LICENSE and Terms of Services 📰
- 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.
- The WAQI API, which Ozone uses to provide data, has it's own Acceptable Usage Policy. Please refer to it for more details.
Enjoy using Ozone! 🥳 🍾 🚀
Created by Milind Sharma
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.