Merge branch 'release-1.4.2'

README.md

@@ -32,6 +32,8 @@ I want to make it easy to get your hands on accurate air quality data for your p
 pip install ozon3
 ```
 
+You can find more information on the PyPI page for Ozone [here](https://pypi.org/project/ozon3/) (called as Ozon3 on PyPI).
+
 ## Getting your API token :atom:
 
 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 👮🏼‍♂️.

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ozon3
-version = 1.4.1
+version = 1.4.2
 author = Milind Sharma
 author_email = [email protected]
 description = A package to get air quality data using the WAQI API

setup.py

@@ -9,8 +9,8 @@
  description="A package to get air quality data using the WAQI API",
  license="GPLv3+",
  url="https://github.com/Milind220/Ozone",
- version="1.4.1",
- download_url="https://github.com/Milind220/Ozone/archive/refs/tags/v1.4.1.tar.gz",
+ version="1.4.2",
+ download_url="https://github.com/Milind220/Ozone/archive/refs/tags/v1.4.2.tar.gz",
  packages=setuptools.find_packages(),
  install_requires=[
  "numpy; python_version>='3'",

src/ozone/ozone.py

@@ -118,7 +118,7 @@ def _format_output(
  """Format output data
 
  Args:
- data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xslx'.
+ data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xlsx'.
  df (pandas.DataFrame,): Dataframe object of air quality data.
 
  Returns:
@@ -266,7 +266,7 @@ def get_coordinate_air(
  Args:
  lat (float): Latitude
  lon (float): Longitude
- data_format (str): File format for data. Defaults to 'df'. Choose from 'csv', 'json', 'xslx'.
+ data_format (str): File format for data. Defaults to 'df'. Choose from 'csv', 'json', 'xlsx'.
  df (pandas.DataFrame, optional): An existing dataframe to append the data to.
  params (List[str], optional): A list of parameters to get data for.
  Gets all parameters by default.
@@ -299,7 +299,7 @@ def get_city_air(
 
  Args:
  city (str): The city to get data for.
- data_format (str): File format for data. Defaults to 'df'. Choose from 'csv', 'json', 'xslx'.
+ data_format (str): File format for data. Defaults to 'df'. Choose from 'csv', 'json', 'xlsx'.
  df (pandas.DataFrame, optional): An existing dataframe to append the data to.
  params (List[str], optional): A list of parameters to get data for.
  Gets all parameters by default.
@@ -331,7 +331,7 @@ def get_multiple_coordinate_air(
 
  Args:
  locations (list): A list of pair (latitude,longitude) to get data for.
- data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xslx'.
+ data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xlsx'.
  df (pandas.DataFrame, optional): An existing dataframe to append the data to.
  params (List[str], optional): A list of parameters to get data for.
  Gets all parameters by default.
@@ -362,7 +362,7 @@ def get_range_coordinates_air(
  Args:
  lower_bound (tuple): start coordinate
  upper_bound (tuple): end coordinate
- data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xslx'.
+ data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xlsx'.
  df (pandas.DataFrame, optional): An existing dataframe to append the data to.
  params (List[str], optional): A list of parameters to get data for.
  Gets all parameters by default.
@@ -389,7 +389,7 @@ def get_multiple_city_air(
 
  Args:
  cities (list): A list of cities to get data for.
- data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xslx'.
+ data_format (str): File format. Defaults to 'df'. Choose from 'csv', 'json', 'xlsx'.
  params (List[str], optional): A list of parameters to get data for.
  Gets all parameters by default.
  df (pandas.DataFrame, optional): An existing dataframe to append the data to.