ozon3
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.
Science Score: 10.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 18 committers (5.6%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.5%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
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.
Basic Info
Statistics
- Stars: 71
- Watchers: 2
- Forks: 25
- Open Issues: 3
- Releases: 36
Topics
Metadata Files
README.md
 [](https://github.com/Ozon3Org/Ozon3/actions/workflows/pages/pages-build-deployment) [](https://github.com/Ozon3Org/Ozon3/actions/workflows/dependency-review.yml) [](https://github.com/Ozon3Org/Ozon3/actions/workflows/test.yml) [](https://codecov.io/github/Ozon3Org/Ozon3)
[](https://www.buymeacoffee.com/MilindSharma)
## 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
Table of Contents
Contributing and submitting PR's
Install it here!
sh
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
```python import ozon3 as ooo
o3 = ooo.Ozon3('YOURPRIVATETOKEN') data = o3.getcityair('New Delhi') ```
for many cities:
python
data = o3.get_multiple_city_air(['London', 'Hong Kong', 'New York']) # As many locations as you need
Historical data
python
data = o3.get_historical_data(city='Houston') # data from 2014 onwards!
Examples In Action 🎬
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:
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
- Name: Ozon3
- Login: Ozon3Org
- Kind: organization
- Email: milindsharma8@gmail.com
- Repositories: 1
- Profile: https://github.com/Ozon3Org
Ozon3 is an open-source system to obtain air quality data for anywhere in the world.
GitHub Events
Total
- Watch event: 6
- Issue comment event: 5
- Pull request review event: 1
- Pull request event: 1
- Fork event: 1
Last Year
- Watch event: 6
- Issue comment event: 5
- Pull request review event: 1
- Pull request event: 1
- Fork event: 1
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Milind Sharma | m****8@g****m | 140 |
| Nuclear03020704 | 5****n@u****m | 118 |
| Milind Sharma | 6****0@u****m | 74 |
| Sam | s****r@g****m | 9 |
| Kristina Mancini | k****p@p****u | 7 |
| TarikSouabny | 6 | |
| Corey | c****6@g****m | 4 |
| Ireoluwatomiwa | s****x@g****m | 4 |
| Tarik Souabny | 7****y@u****m | 4 |
| tariksouabny | t****y@b****g | 4 |
| ubongab | u****b@g****m | 4 |
| AliShahpurwala | s****a@m****a | 3 |
| Giuseppe Moscato | g****o@r****u | 3 |
| iGotAdigBick | 1****k@u****m | 3 |
| Joe Chilcott | j****t@g****m | 2 |
| Amitesh | r****h@g****m | 1 |
| Noor Kowshik | k****r@g****m | 1 |
| ShootGan | n****a@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- 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 requests: 73
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 1
- Average comments per issue: 3.0
- Average comments per pull request: 1.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- Milind220 (55)
- lahdjirayhan (4)
- Sam-damn (2)
- ubongab (2)
- jimfoundry (1)
- tariksouabny (1)
- mullerhai (1)
Pull Request Authors
- lahdjirayhan (27)
- Milind220 (17)
- Sam-damn (7)
- kristinamancini (4)
- Tomiiwa (4)
- ShootGan (3)
- tariksouabny (3)
- corey-new (2)
- RohanRusta21 (2)
- iGotAdigBick (2)
- ubongab (2)
- Miller2014 (2)
- hkafrawi (2)
- AliShahpurwala (2)
- antocommi (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 364 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 106
- Total maintainers: 1
proxy.golang.org: github.com/Ozon3Org/Ozon3
- Documentation: https://pkg.go.dev/github.com/Ozon3Org/Ozon3#section-documentation
- License: gpl-3.0
-
Latest release: v4.0.2+incompatible
published about 3 years ago
Rankings
proxy.golang.org: github.com/ozon3org/ozon3
- Documentation: https://pkg.go.dev/github.com/ozon3org/ozon3#section-documentation
- License: gpl-3.0
-
Latest release: v4.0.2+incompatible
published about 3 years ago
Rankings
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/
- License: GPLv3+
-
Latest release: 4.0.2
published about 3 years ago
Rankings
Maintainers (1)
Dependencies
- 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
- js2py *
- numpy *
- openpyxl *
- pandas *
- ratelimit *
- requests *
- sseclient-py *
- actions/checkout v2 composite
- actions/setup-python v2 composite
- codecov/codecov-action v3 composite
- actions/checkout v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- actions/checkout v3 composite
- actions/dependency-review-action v1 composite
- actions/first-interaction v1 composite
- actions/checkout master composite
- actions/setup-python v1 composite
- actions/checkout master composite
- actions/setup-python v1 composite
- pypa/gh-action-pypi-publish master composite
- kowshik-noor/take-action beer-comment composite
- actions/checkout v2 composite
- actions/setup-python v2 composite