Merge branch 'release-4.0.1'

FILE_STRUCTURE.md

@@ -1,5 +1,5 @@
 # File Structure
-This document is a reference primer on Ozon3's files: what, where, and for what.
+This document is a reference primer on Ozon3's files: what, where, and why.
 
 - [src/](#src)
   - [media/](#media)
@@ -17,7 +17,6 @@ This document is a reference primer on Ozon3's files: what, where, and for what.
 - [.pre-commit-config.yaml](#pre-commit-configyaml)
 - [pyproject.toml, setup.py, and setup.cfg](#pyprojecttoml-setuppy-and-setupcfg)
 - [requirements.txt](#requirementstxt)
-- [updateVersion.sh](#updateversionsh)
 - [.github/](#github)
   - [ISSUE_TEMPLATE/](#issue_template)
   - [workflows/](#workflows)
@@ -89,10 +88,6 @@ Files used for purposes of packaging and installation. Also contains package inf
 
 Dependency requirement file for development. Non-developing users won't need to install packages in this file, as the installation process will install the user requirements automatically.
 
-## updateVersion.sh
-
-A custom shell script to automatically increment version. This is purely a convenience script so that each time Ozon3 needs a new release, we won't need to alter the version numbers in multiple places by hand.
-
 ## .github/
 
 This folder is related to GitHub repository and not necessarily part of Ozon3 package.

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ozon3
-version = 4.0.0
+version = 4.0.1
 author = Milind Sharma
 author_email = milindsharma8@gmail.com
 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.

setup.py

@@ -11,8 +11,8 @@
     "accurate and simple.",
     license="GPLv3+",
     url="https://github.com/Ozon3Org/Ozon3",
-    version="4.0.0",
-    download_url="https://github.com/Ozon3Org/Ozon3/archive/refs/tags/v4.0.0.tar.gz",
+    version="4.0.1",
+    download_url="https://github.com/Ozon3Org/Ozon3/archive/refs/tags/v4.0.1.tar.gz",
     packages=setuptools.find_packages(),
     install_requires=[
         "numpy; python_version>='3'",

src/ozon3/ozon3.py

@@ -425,7 +425,7 @@ def get_range_coordinates_air(
         upper_bound: Tuple[float, float],
         df: pandas.DataFrame = pandas.DataFrame(),
     ) -> pandas.DataFrame:
-        """Get air quality data for range of coordinates between lower_bound and upper_bound
+        """Get aqi data for range of coordinates b/w lower_bound and upper_bound
 
         Args:
             lower_bound (tuple): start coordinate
@@ -539,7 +539,7 @@ def get_city_station_options(self, city: str) -> pandas.DataFrame:
         ).sort_values(by=["score"], ascending=False)
 
     def get_historical_data(
-        self, city: str = None, city_id: int = None
+        self, city: str = None, city_id: int = None  # type: ignore
     ) -> pandas.DataFrame:
         """Get historical air quality data for a city
 

tests/utils.py

@@ -1,4 +1,3 @@
-from pathlib import Path
 from urllib.parse import urlsplit, urlunsplit, urlencode
 import vcr
 from decouple import config
@@ -36,4 +35,4 @@ def before_record_response(response):
 # Prepare a global Ozon3 object
 WAQI_TOKEN = config("WAQI_TOKEN", default="DUMMY_TOKEN")
 with vcr.use_cassette("tests/cassettes/ozon3_init.yaml", **vcr_kwargs):
-    api = Ozon3(WAQI_TOKEN)
+    api = Ozon3(WAQI_TOKEN)  # type: ignore