Merge pull request #38 from UBC-MDS/feat-add-get-pollution-forecast

Adds readme instructions and solves package dependencies

README.md

@@ -30,12 +30,23 @@ Although there is an abundance of python weather packages and APIs in the Python
 ## Installation
 
 ```bash
-$ pip install airpyllution
+$ pip install --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple airpyllution
 ```
 
 ## Usage
 
-- TODO
+1. Create an OpenWeatherMap API key
+2. Install airpyllution
+3. Run the following code from terminal after replacing your api key.
+```
+from airpyllution import airpyllution
+df = airpyllution.get_pollution_history(1606488670, 1606747870, 49.28, 123.12, "your_api_key")
+world_chart = airpyllution.get_air_pollution(49.2497, -123.1193, "your_api_key")
+world_chart.show()
+time_chart = airpyllution.get_pollution_forecast(45.0,180.0,"your_api_key")
+time_chart.show()
+```
 
 ## Contributing
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "airpyllution"
-version = "0.1.0"
+version = "0.1.2"
 description = "A package which  provides various functionalities on air pollution data."
 authors = ["Christopher Alexander, Daniel King, Mel Liow"]
 license = "MIT"
@@ -15,10 +15,10 @@ numpy = "^1.22.1"
 pandas = "^1.3.5"
 requests = "^2.27.1"
 python-dotenv = "^0.19.2"
-unittest = "^0.0"
 responses = "^0.17.0"
 plotly = "^5.5.0"
 altair-viewer = "^0.4.0"
+mock = "^4.0.3"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2.5"