Merge branch 'release-2.0.1'

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ main, dev, gh-pages ]
+ pull_request:
+ # The branches below must be a subset of the branches above
+ branches: [ dev ]
+ schedule:
+ - cron: '40 8 * * 2'
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ 'python' ]
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+ # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v2
+ with:
+ languages: ${{ matrix.language }}
+ # If you wish to specify custom queries, you can do so here or in a config file.
+ # By default, queries listed here will override any specified in a config file.
+ # Prefix the list here with "+" to use these queries and those in the config file.
+
+ # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+ # queries: security-extended,security-and-quality
+
+
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
+ # If this step fails, then you should remove it and run the build manually (see below)
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v2
+
+ # ℹ️ Command-line programs to run using the OS shell.
+ # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+ # If the Autobuild fails above, remove it and uncomment the following three lines. 
+ # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+ # - run: |
+ # echo "Run, Build Application using script"
+ # ./location_of_script_within_repo/buildscript.sh
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2

CODE_OF_CONDUCT.md

@@ -1,18 +1,11 @@
 # Code Of Conduct
 
-I value participation of every member of our community and want to ensure that every contributor
-has an _enjoyable_ and _fulfilling_ experience.
+All members of the Ozone community should try to follow this **Code of Conduct**:
 
-I want this package to be easy for _newbies_ and _anxious collaborators_, people who are looking to learn
-and develop their skills.
 
-It is expected from all the members of the community to conform to the following **Code of Conduct**:
+* Encourage constructive discourse and new contributors.
 
-```
-* Encourage constructive discourse and discourage berating new contributors.
-
-* Encourage new ideas about features and enhancements as long as they don't go against the goal of Ozone
- to be the most simplest, most effective package for fetching air quality data.
+* Encourage the discussion of new ideas about features and enhancements as long as they don't go against the goal of Ozone
+ to be the most effective package for fetching air quality data.
 
 * Have a fun time.
-```

README.md

@@ -4,27 +4,27 @@
 
 </br>
 
-# Ozone 
+# Ozone
 
 ![SVG of ozone logo](/src/media/ozone_logo.svg)
 
-[![PyPI version](https://badge.fury.io/py/ozon3.svg)](https://badge.fury.io/py/ozon3)
-<a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
-![GitHub](https://img.shields.io/github/license/Milind220/Ozone)
-[![Complete Documentation](https://github.com/Milind220/Ozone/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/Milind220/Ozone/actions/workflows/pages/pages-build-deployment)
-[![Dependency Review](https://github.com/Milind220/Ozone/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/Milind220/Ozone/actions/workflows/dependency-review.yml)
+[![PyPI version](https://badge.fury.io/py/ozon3.svg)](https://badge.fury.io/py/ozon3) <a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a> ![GitHub](https://img.shields.io/github/license/Milind220/Ozone) [![Complete Documentation](https://github.com/Milind220/Ozone/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/Milind220/Ozone/actions/workflows/pages/pages-build-deployment) [![Dependency Review](https://github.com/Milind220/Ozone/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/Milind220/Ozone/actions/workflows/dependency-review.yml)
 [![Buy Me a Coffee](https://img.shields.io/badge/buy_me_a_coffee-orange.svg?style=flat)](https://www.buymeacoffee.com/MilindSharma)
 
 ## The simplest AQI API
 
 </div>
 
-Getting air quality data with Python should be easy and straightforward - and that's exactly what Ozone can help you with. 
+Getting air quality data with Python should be easy and straightforward - and that's exactly what Ozone can help you with.
 With Ozone, 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 Ozone 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](https://milind220.github.io/Ozone/)
+
+
+_You can view our complete documentation [here](https://milind220.github.io/Ozone/)_
+
+_Don't forget to star Ozone repository if you found it helpful_
 
 #### Table of Contents
 
@@ -67,7 +67,7 @@ Get your token [here](https://aqicn.org/data-platform/token/#/)!
 import ozone as ooo
 
 o3 = ooo.Ozone('YOUR_PRIVATE_TOKEN')
-data = o3.get_city_air('New Delhi') 
+data = o3.get_city_air('New Delhi')
 ```
 
 for many cities:
@@ -108,8 +108,7 @@ Ozone can fetch the following parameters:
  * `w`: wind speed, a measure of air in motion. It is measured in kilometers per hour (km/h)
 
 Sample output:
-<img width="1065" alt="blehblhe" src="https://user-images.githubusercontent.com/68847270/159113134-e7e2d76d-c64d-4f96-83c4-e85d8c76b503.png">
-
+<img width="1065" alt="blehblhe" src="./src/media/sample-output.png">
 
 ## Contributing and submitting Pull requests
 
@@ -138,7 +137,7 @@ This package is a wrapper around an API provided by the World Air Quality Index
 
 ## Contributors
 
-Contributions of any kind are welcome and these are our amazing contributors.
+Contributions of any kind are welcome! These are our amazing contributors :)
 
 <a href="https://github.com/Milind220/Ozone/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=Milind220/Ozone" />

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ozon3
-version = 2.0.0
+version = 2.0.1
 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="2.0.0",
- download_url="https://github.com/Milind220/Ozone/archive/refs/tags/v2.0.0.tar.gz",
+ version="2.0.1",
+ download_url="https://github.com/Milind220/Ozone/archive/refs/tags/v2.0.1.tar.gz",
  packages=setuptools.find_packages(),
  install_requires=[
  "numpy; python_version>='3'",