Merge branch 'release-3.0.0'

Ozon3Org · May 29, 2022 · aa88efb · aa88efb
2 parents 4a51502 + fa07025
commit aa88efb
Show file tree

Hide file tree

Showing 64 changed files with 2,199 additions and 8,582 deletions.
diff --git a/README.md b/README.md
@@ -79,17 +79,17 @@ data = o3.get_multiple_city_air(['London', 'Hong Kong', 'New York'])     # As ma
 ### Historical data
 
 ```python
-data = o3.get_historical_data(city='Houston', data_format='df')     # data from 2014 onwards!
+data = o3.get_historical_data(city='Houston')     # data from 2014 onwards!
 ```
 
 <hr>
 
 ### Examples In Action 🎬
-![Gif of ozone.get_city_air()](/src/media/ozone_get_city_air.gif)
+![Gif of Ozone.get_city_air()](/src/media/example_get_city_air.gif)
 
-![Gif of ozone.get_multiple_city_air()](/src/media/ozone_get_multiple_city_air_updated.gif)
+![Gif of Ozone.get_multiple_city_air()](/src/media/example_get_multiple_city_air.gif)
 
-![Gif of ozone.get_historical_data()](/src/media/ozone_historical_data.gif)
+![Gif of Ozone.get_historical_data()](/src/media/example_get_historical_data.gif)
 ### Air Quality Parameters
 
 Ozone can fetch the following parameters:

diff --git a/setup.cfg b/setup.cfg
@@ -1,9 +1,9 @@
 [metadata]
 name = ozon3
-version = 2.0.2
+version = 3.0.0
 author = Milind Sharma
 author_email = milindsharma8@gmail.com
-description = A package to get air quality data using the WAQI API
+description = An open-source package to easily obtain real-time, historical, or forecasted air quality data for anywhere in the world. Reliable, accurate and simple.
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/Milind220/Ozone

diff --git a/setup.py b/setup.py
@@ -6,11 +6,13 @@
     author="Milind Sharma",
     author_email="milindsharma8@gmail.com",
     keywords=["aqi", "air quality", "world air quality", "api", "open source"],
-    description="A package to get air quality data using the WAQI API",
+    description="An open-source package to easily obtain real-time, historical,"
+    "or forecasted air quality data for anywhere in the world. Reliable,"
+    "accurate and simple.",
     license="GPLv3+",
     url="https://github.com/Milind220/Ozone",
-    version="2.0.2",
-    download_url="https://github.com/Milind220/Ozone/archive/refs/tags/v2.0.2.tar.gz",
+    version="3.0.0",
+    download_url="https://github.com/Milind220/Ozone/archive/refs/tags/v3.0.0.tar.gz",
     packages=setuptools.find_packages(),
     install_requires=[
         "numpy; python_version>='3'",

diff --git a/src/media/example_get_city_air.gif b/src/media/example_get_city_air.gif
diff --git a/src/media/example_get_historical_data.gif b/src/media/example_get_historical_data.gif
diff --git a/src/media/example_get_multiple_city_air.gif b/src/media/example_get_multiple_city_air.gif
diff --git a/src/media/ozone_get_city_air.gif b/src/media/ozone_get_city_air.gif
diff --git a/src/media/ozone_get_multiple_city_air_updated.gif b/src/media/ozone_get_multiple_city_air_updated.gif
diff --git a/src/media/ozone_historical_data.gif b/src/media/ozone_historical_data.gif