Ozone3

An open-source package to easily obtain real-time, historical, or forecasted air quality data for anywhere in the world.
https://github.com/ozon3org/ozon3

Category: Natural Resources
Sub Category: Air Quality

Keywords

air-quality air-quality-api air-quality-data air-quality-index api api-wrapper aqi aqi-readings open-source python python-package python3 python3-package waqi

Keywords from Contributors

measurements sanitation control training featured feature-flag feature-toggle

Last synced: about 14 hours ago
JSON representation

Repository metadata

An open-source Python package to easily obtain real-time, historical, or forecasted air quality data for anywhere in the world. Reliable, accurate and simple.

Host: GitHub
URL: https://github.com/ozon3org/ozon3
Owner: Ozon3Org
License: gpl-3.0
Created: 2022-01-28T04:52:53.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-03-18T19:40:35.000Z (about 1 year ago)
Last Synced: 2025-04-20T09:44:33.592Z (7 days ago)
Topics: air-quality, air-quality-api, air-quality-data, air-quality-index, api, api-wrapper, aqi, aqi-readings, open-source, python, python-package, python3, python3-package, waqi
Language: Python
Homepage:
Size: 6.41 MB
Stars: 68
Watchers: 2
Forks: 25
Open Issues: 3
Releases: 36
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Ozon3

SVG of ozon3 logo

GitHub

The simplest AQI API

Getting air quality data with Python should be easy and straightforward - and that's exactly what Ozon3 can help you with.
With Ozon3, just 4 lines of code are enough to get you the data you need. And the best part is that you can trust this data to be accurate and reliable, since the package uses the World Air Quality Index's API under the hood! ✅ 📈

Use Ozon3 to get real-time air quality data, or historical data from 2014 onwards, and fetch air quality data for anywhere in the world in seconds.

You can view our complete documentation here

Don't forget to star Ozon3 repository if you found it helpful

Install ozon3

Getting your API token

Getting started

Contributing and submitting PR's

Semantic Versioning System

Attributions

License and TOS

Contributors

Install it here!

pip install ozon3

You can find more information on the PyPI page for Ozon3 here

Getting your API token

To use Ozon3, 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

Real-time data

import ozon3 as ooo

o3 = ooo.Ozon3('YOUR_PRIVATE_TOKEN')
data = o3.get_city_air('New Delhi')

for many cities:

data = o3.get_multiple_city_air(['London', 'Hong Kong', 'New York'])     # As many locations as you need

Historical data

data = o3.get_historical_data(city='Houston')     # data from 2014 onwards!

Examples In Action 🎬

Gif of Ozon3.get_city_air()

Gif of Ozon3.get_multiple_city_air()

Gif of Ozon3.get_historical_data()

Air Quality Parameters

Ozon3 can fetch the following parameters:

aqi: air quality index, a measurement of air quality that tells you how clean or polluted the air is. It is measured in micrograms per cubic meter (µg/m3).
pm25: fine particulate matter, a measure of 2.5 micrometers or smaller particles in the air. It is measured in micrograms per cubic meter (µg/m3).
pm10: respirable particulate matter, a measure of 10 micrometers or smaller particles in the air. It is measured in micrograms per cubic meter (µg/m3).
o3: a measure of ground level ozon3 concentrations in the air. It is measured in parts per billion (ppb).
co: a measure of carbon monoxide concentrations in the air. It is measured in parts per billion (ppb).
no2: a measure of nitrogen dioxide concentrations in the air. It is measured in parts per billion (ppb).
so2: a measure of sulfur dioxide concentrations in the air. It is measured in parts per billion (ppb).
dew: dew point, the temperature the air needs to be cooled to in order to reach 100% relative humidity. It is measured in Celsius (°C) or Fahrenheit (°F).
h: relative humidity, a measure of moisture in the atmosphere. It does not have a standard unit of measurement.
p: atmospheric pressure, a measure of the weight of atoms and molecules that make up the layers in the atmosphere. It is measured in Pascal (Pa).
t: temperature, a measure of thermal energy in one or a combined substance at a given time. It is measured in Celsius (°C) or Fahrenheit (°F).
w: wind speed, a measure of air in motion. It is measured in kilometers per hour (km/h)

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

Ozon3 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, Ozon3 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 📰

Ozon3 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 Ozon3 uses to provide data, has it's own Acceptable Usage Policy. Please refer to it for more details.

Contributors

Contributions of any kind are welcome! These are our amazing contributors :)

Enjoy using Ozon3!
🥳 🍾 🚀

Created by Milind Sharma

Owner metadata

Name: Ozon3
Login: Ozon3Org
Email: [email protected]
Kind: organization
Description: Ozon3 is an open-source system to obtain air quality data for anywhere in the world.
Website:
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/107499002?v=4
Repositories: 1
Last ynced at: 2023-03-06T17:49:27.162Z
Profile URL: https://github.com/Ozon3Org

GitHub Events

Total

Watch event: 3
Issue comment event: 5
Pull request review event: 1
Pull request event: 1
Fork event: 1

Last Year

Watch event: 3
Issue comment event: 5
Pull request review event: 1
Pull request event: 1
Fork event: 1

Committers metadata

Last synced: 4 days ago

Total Commits: 388
Total Committers: 16
Avg Commits per committer: 24.25
Development Distribution Score (DDS): 0.448

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name	Email	Commits
Milind Sharma	m**8@g**m	214
Nuclear03020704	5****n	118
Sam	s**r@g**m	9
Tarik Souabny	7****y	8
Kristina Mancini	k**p@p**u	7
TarikSouabny		6
ubongab	u**b@g**m	4
Ireoluwatomiwa	s**x@g**m	4
Corey	c**6@g**m	4
Giuseppe Moscato	g**o@r**u	3
iGotAdigBick	1****k	3
AliShahpurwala	s**a@m**a	3
Joe Chilcott	j**t@g**m	2
ShootGan	n**a@g**m	1
Noor Kowshik	k**r@g**m	1
Amitesh	r**h@g**m	1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 66
Total pull requests: 80
Average time to close issues: 13 days
Average time to close pull requests: 4 days
Total issue authors: 7
Total pull request authors: 18
Average comments per issue: 4.71
Average comments per pull request: 1.16
Merged pull request: 73
Bot issues: 0
Bot pull requests: 0

Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 3.0
Past year average comments per pull request: 1.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/ozon3org/ozon3

Top Issue Authors

Milind220 (55)
lahdjirayhan (4)
Sam-damn (2)
ubongab (2)
jimfoundry (1)
tariksouabny (1)
mullerhai (1)

Top Pull Request Authors

lahdjirayhan (27)
Milind220 (17)
Sam-damn (7)
Tomiiwa (4)
kristinamancini (4)
tariksouabny (3)
ubongab (2)
ShootGan (2)
corey-new (2)
iGotAdigBick (2)
Miller2014 (2)
AliShahpurwala (2)
antocommi (1)
RohanRusta21 (1)
hkafrawi (1)

Top Issue Labels

good first issue (30)
documentation (23)
bug (19)
beginner (15)
enhancement (12)
urgent (9)
help wanted (4)
breaking change (1)
ci/cd (1)
duplicate (1)
question (1)

Top Pull Request Labels

ci/cd (3)
breaking change (1)
bug (1)
documentation (1)

Package metadata

Total packages: 1
Total downloads:
- pypi: 1,540 last-month
Total dependent packages: 0
Total dependent repositories: 1
Total versions: 34
Total maintainers: 1

pypi.org: ozon3

An open-source package to easily obtain real-time, historical,or forecasted air quality data for anywhere in the world. Reliable,accurate and simple.

Homepage: https://github.com/Ozon3Org/Ozon3
Documentation: https://ozon3.readthedocs.io/
Licenses: GPLv3+
Latest release: 4.0.2 (published about 2 years ago)
Last Synced: 2025-04-25T12:10:01.809Z (1 day ago)
Versions: 34
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 1,540 Last month
Rankings:
- Dependent packages count: 7.373%
- Forks count: 8.14%
- Stargazers count: 9.256%
- Average: 12.827%
- Downloads: 17.133%
- Dependent repos count: 22.233%
Maintainers (1)
- Milind220

Dependencies

requirements.txt pypi

black *
flake8 *
js2py ==0.71
mypy *
numpy ==1.22.2
openpyxl *
pandas ==1.4.1
pre-commit *
pytest ==7.1.1
pytest-recording ==0.12.0
python-decouple ==3.6
ratelimit ==2.2.1
requests ==2.27.1
sseclient-py ==1.7.2

setup.py pypi

js2py *
numpy *
openpyxl *
pandas *
ratelimit *
requests *
sseclient-py *

.github/workflows/codecov.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
codecov/codecov-action v3 composite

.github/workflows/codeql-analysis.yml actions

actions/checkout v3 composite
github/codeql-action/analyze v2 composite
github/codeql-action/autobuild v2 composite
github/codeql-action/init v2 composite

.github/workflows/dependency-review.yml actions

actions/checkout v3 composite
actions/dependency-review-action v1 composite

.github/workflows/greetings.yml actions

actions/first-interaction v1 composite

.github/workflows/lint.yml actions

actions/checkout master composite
actions/setup-python v1 composite

.github/workflows/package-publish.yml actions

actions/checkout master composite
actions/setup-python v1 composite
pypa/gh-action-pypi-publish master composite

.github/workflows/take.yml actions

kowshik-noor/take-action beer-comment composite

.github/workflows/test.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

pyproject.toml pypi

Score: 14.376104153404372

Ozone3

Keywords

Keywords from Contributors

Repository metadata

README.md

Ozon3

The simplest AQI API

Table of Contents

Install it here!

Getting your API token

Getting started

Real-time data

Historical data

Examples In Action 🎬

Air Quality Parameters

Contributing and submitting Pull requests

Semantic Versioning System

World Air Quality Index and EPA attribution

LICENSE and Terms of Services 📰

Contributors

Created by Milind Sharma

Owner metadata

GitHub Events

Total

Last Year

Committers metadata

Committer domains:

Issue and Pull Request metadata

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

pypi.org: ozon3

Dependencies