updated doc

Author: ExpDev07

README.md

@@ -12,37 +12,95 @@
 
 ## Endpoints
 
-All requests must be made to the base url: ``https://coronavirus-tracker-api.herokuapp.com`` (e.g: https://coronavirus-tracker-api.herokuapp.com/all). You can try them out in your browser to further inspect responses.
+All requests must be made to the base url: ``https://coronavirus-tracker-api.herokuapp.com/v2/`` (e.g: https://coronavirus-tracker-api.herokuapp.com/v2/locations). You can try them out in your browser to further inspect responses.
 
-Getting confirmed cases, deaths, and recoveries:
+### Getting latest amount of total confirmed cases, deaths, and recoveries.
 ```http
-GET /all
+GET /v2/latest
 ```
 ```json
-{ "latest": { ... }, "confirmed": { ... }, "deaths": { ... }, "recovered": { ... } }
+{
+  "latest": {
+    "confirmed": 197146,
+    "deaths": 7905,
+    "recovered": 80840
+  }
+}
 ```
 
-Getting just confirmed:
+### Getting all locations.
 ```http
-GET /confirmed
+GET /v2/locations
 ```
 ```json
 {
-  "latest": 42767,
-  "locations": [ ... ], 
-  "last_updated": "2020-03-07T18:08:58.432242Z", 
-  "source": "https://github.com/ExpDev07/coronavirus-tracker-api" 
+  "locations": [
+    {
+      "id": 0,
+      "country": "Thailand",
+      "country_code": "TH",
+      "province": "",
+      "coordinates": {
+        "latitude": "15",
+        "longitude": "101"
+      },
+      "latest": {
+        "confirmed": 177,
+        "deaths": 1,
+        "recovered": 41
+      }
+    },
+    {
+      "id": 39,
+      "country": "Norway",
+      "country_code": "NO",
+      "province": "",
+      "coordinates": {
+        "latitude": "60.472",
+        "longitude": "8.4689"
+      },
+      "latest": {
+        "confirmed": 1463,
+        "deaths": 3,
+        "recovered": 1
+      }
+    }
+  ]
 }
 ```
 
-Getting just deaths:
+Additionally, you can also filter by country ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
 ```http
-GET /deaths
+GET /v2/locations?country_code=US
 ```
 
-Getting just recoveries:
+### Getting a specific location (includes timeline).
 ```http
-GET /recovered
+GET /v2/locations/:id
+```
+```json
+{
+  "location": {
+      "id": 39,
+      "country": "Norway",
+      "country_code": "NO",
+      "province": "",
+      "coordinates": { },
+      "latest": { },
+      "timelines": {
+        "confirmed": {
+          "latest": 1463,
+          "timeline": {
+            "2020-03-16T00:00:00Z": 1333,
+            "2020-03-17T00:00:00Z": 1463
+          }
+        },
+        "deaths": { },
+        "recovered": { }
+      }
+    }
+  }
+}
 ```
 
 ## Data
@@ -112,5 +170,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 ## License
 
-The data is available to the public strictly for educational and academic research purposes. Please link to this repo somewhere in your project if you can (not required) :).
+The data is available to the public strictly for educational and academic research purposes. Please link to this repo somewhere in your project :).
 

app/services/location/jhu.py

@@ -49,7 +49,7 @@ def get_category(category):
     # The normalized locations.
     locations = []
 
-    for i, item in enumerate(data):
+    for item in data:
         # Filter out all the dates.
         dates = dict(filter(lambda element: date_util.is_date(element[0]), item.items()))
 

app/utils/countrycodes.py

@@ -346,8 +346,7 @@
 
 def country_code(country):
     """
-    Return two letter country code (Alpha-2) according to
-    https://en.wikipedia.org/wiki/ISO_3166-1
+    Return two letter country code (Alpha-2) according to https://en.wikipedia.org/wiki/ISO_3166-1
     Defaults to "XX".
     """
     if country in is_3166_1: