Code Monkey home page Code Monkey logo

ozone-1's Introduction

Ozone

PyPI version PRs Welcome GitHub

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.

Table of Contents

Install ozon3

Getting your API token

Getting started

Contributing and submitting PR's

Attributions

License and TOS

Install it here!

pip install ozon3

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

Gif of ozone.get_city_air()

Gif of ozone.get_multiple_city_air()

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!

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:

World Air Quality Index

United States Environmental Protection Agency

LICENSE and Terms of Services

  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!

ozone-1's People

Contributors

milind220 avatar tariksouabny avatar ubongab avatar samxx97 avatar igotadigbick avatar amitesh100 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.