Merge branch 'release-1.4.5'

.github/workflows/take.yml

@@ -0,0 +1,15 @@
+name: Assign issue to contributor
+on:
+ issue_comment:
+ types: [created, edited]
+
+
+jobs:
+ assign:
+ name: Take an issue
+ runs-on: ubuntu-latest
+ steps:
+ - name: take the issue
+ uses: kowshik-noor/take-action@beer-comment
+ env:
+ GITHUB_TOKEN: ${{ github.token }}

CONTRIBUTING.md

@@ -17,12 +17,15 @@ The following is a set of guidelines for contributing to [Ozone](https://github.
  * [Reporting Bugs](#reporting-bugs)
  * [Suggesting Enhancements or Feature](#suggesting-enhancements-or-features)
  * [Your First Code Contribution](#your-first-code-contribution)
+ * [How to get an issue assigned to you](#how-to-get-an-issue-assigned-to-you)
  * [Pull Requests](#pull-requests)
 
 [Styleguides](#styleguides)
  * [Git Commit Messages](#git-commit-messages)
  * [Python Styleguide](#python-styleguide)
 
+[Github Branching Model](#github-branching-model)
+
 ## I don't want to read this whole thing I just have a question!!!
 
 > **Note:** Please don't file an issue to ask a question. Search for your question in issues and see if it's already been answered. Also check out the [discussions](https://github.com/Milind220/Ozone/discussions) tab to see if we've chatted about it before. Post it there if it's an idea, or in issues if there's a change to be made.
@@ -89,6 +92,12 @@ Unsure where to begin contributing to Ozone? You can start by looking through th
 * `beginner` issues are a step up, and may involve a couple of methods/tests.
 * `help-wanted` issues are slightly trickier and require more code and logic.
 
+### How to get an issue assigned to you
+
+**If you find an issue that you'd like to tackle - get it assigned to yourself by commenting on it with:**
+
+ Hold my beer, I got this
+
 ### Pull Requests (PR's)
 
 Here's how you can get started:
@@ -153,3 +162,10 @@ Here are a few other tips:
 * Follow the [pep8](https://www.python.org/dev/peps/pep-0008/) styleguide
 * Format with flake8 and black
 * Add docstrings as shown in existing code
+
+## Github Branching Model
+
+Ozone branches are created using a Github branching model. In this branching model, each branch serves a purpose and offers team members a shared undestanding of the branching system.
+
+See more information on this branching model [here](https://github.com/Milind220/Ozone/discussions/24).
+

README.md

@@ -3,6 +3,8 @@
 [![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)
+[![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
@@ -21,6 +23,7 @@ I want to make it easy to get your hands on accurate air quality data for your p
 
 [Contributing and submitting PR's](#contributing-and-submitting-pull-requests)
 
+[Semantic Versioning System](#semantic-versioning-system)
 
 [Attributions](#World-Air-Quality-Index-and-EPA-attribution)
 
@@ -32,9 +35,9 @@ 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).
+You can find more information on the PyPI page for Ozone [here](https://pypi.org/project/ozon3/) (called ozon3 on PyPI).
 
-## Getting your API token :atom:
+## Getting your API token 
 
 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 👮🏼‍♂️.
 
@@ -64,12 +67,22 @@ data = o3.get_multiple_city_air([ARRAY OF CITY NAMES])
 
 ![Gif of ozone.get_multiple_city_air()](/src/media/ozone_get_multiple_city_air_updated.gif)
 
+
+Sample output:
+<img width="1065" alt="blehblhe" src="https://user-images.githubusercontent.com/68847270/159113134-e7e2d76d-c64d-4f96-83c4-e85d8c76b503.png">
+
+
 ## Contributing and submitting Pull requests
 
 **We love PR's!**
 
 Take a look at the [CONTRIBUTING.md](https://github.com/Milind220/Ozone/blob/main/CONTRIBUTING.md) file for details on how to go about this!
 
+## Semantic Versioning System
+
+Ozone 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](https://github.com/Milind220/Ozone/discussions/26).
 
 ## World Air Quality Index and EPA attribution
 
@@ -87,4 +100,4 @@ This package is a wrapper around an API provided by the World Air Quality Index
 Enjoy using Ozone!
 🥳 🍾 🚀
 
-#### _Created by Milind Sharma_
+#### _Created by [Milind Sharma](https://github.com/Milind220)_

setup.cfg

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