Merge branch 'master' of https://github.com/ExpDev07/coronavirus-tracker-api

Author: gribok

.all-contributorsrc

@@ -153,6 +153,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "ibhuiyan17",
+      "name": "Ibtida Bhuiyan",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/33792969?v=4",
+      "profile": "http://ibtida.me",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -398,8 +398,16 @@ You will need the following things properly installed on your computer.
 
 * `git clone https://github.com/ExpDev07/coronavirus-tracker-api.git`
 * `cd coronavirus-tracker-api`
-* `pipenv shell`
-* `pipenv install`
+
+1. Make sure you have [`python3.8` installed and on your `PATH`](https://docs.python-guide.org/starting/installation/).
+2. [Install the `pipenv` dependency manager](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)
+   *  with [pipx](https://pipxproject.github.io/pipx/) `$ pipx install pipenv`
+   * with [Homebrew/Linuxbrew](https://pipenv.readthedocs.io/en/latest/install/#homebrew-installation-of-pipenv) `$ brew install pipenv`
+   * with [pip/pip3 directly](https://pipenv.readthedocs.io/en/latest/install/#pragmatic-installation-of-pipenv) `$ pip install --user pipenv`
+3. Create virtual environment and install all dependencies `$ pipenv sync --dev`
+4. Activate/enter the virtual environment `$ pipenv shell`
+
+And don't despair if don't get the python setup working on the first try. No one did. Guido got pretty close... once. But that's another story. Good luck. 
 
 ## Running / Development
 
@@ -408,11 +416,31 @@ You will need the following things properly installed on your computer.
 
 ### Running Tests
 
-* `make test`
+```bash
+pipenv sync --dev
+pipenv shell
+make test
+```
 
 ### Linting
 
-* `make lint`
+```bash
+pipenv sync --dev
+pipenv shell
+make lint
+```
+
+### Formatting
+
+```bash
+pipenv run fmt
+```
+or
+```bash
+pipenv shell
+make fmt
+```
+
 
 ### Building
 
@@ -446,6 +474,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   </tr>
   <tr>
     <td align="center"><a href="https://github.com/Turreted"><img src="https://avatars2.githubusercontent.com/u/41593269?v=4" width="100px;" alt=""/><br /><sub><b>Turreted</b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=Turreted" title="Code">💻</a></td>
+    <td align="center"><a href="http://ibtida.me"><img src="https://avatars1.githubusercontent.com/u/33792969?v=4" width="100px;" alt=""/><br /><sub><b>Ibtida Bhuiyan</b></sub></a><br /><a href="https://github.com/ExpDev07/coronavirus-tracker-api/commits?author=ibhuiyan17" title="Code">💻</a></td>
   </tr>
 </table>
 

app/location/__init__.py

@@ -1,5 +1,5 @@
 from ..coordinates import Coordinates
-from ..utils import countrycodes
+from ..utils import countries
 from ..utils.populations import country_population
 
 
@@ -31,7 +31,7 @@ def country_code(self):
         :returns: The country code.
         :rtype: str
         """
-        return (countrycodes.country_code(self.country) or countrycodes.default_code).upper()
+        return (countries.country_code(self.country) or countries.default_country_code).upper()
 
     @property
     def country_population(self):

app/main.py

@@ -10,15 +10,15 @@
 import uvicorn
 from fastapi import FastAPI, Request, Response
 from fastapi.middleware.cors import CORSMiddleware
-from fastapi.middleware.wsgi import WSGIMiddleware
 from fastapi.responses import JSONResponse
 
 from .core import create_app
 from .data import data_source
 from .models.latest import LatestResponse as Latest
 from .models.location import LocationResponse as Location
 from .models.location import LocationsResponse as Locations
-from .router import router
+from .router.v1 import router as v1router
+from .router.v2 import router as v2router
 
 # ############
 # FastAPI App
@@ -83,11 +83,9 @@ async def handle_validation_error(request: Request, exc: pydantic.error_wrappers
 
 
 # Include routers.
-APP.include_router(router, prefix="/v2", tags=["v2"])
+APP.include_router(v1router, prefix="", tags=["v1"])
+APP.include_router(v2router, prefix="/v2", tags=["v2"])
 
-# mount the existing Flask app
-# v1 @ /
-APP.mount("/", WSGIMiddleware(create_app()))
 
 # Running of app.
 if __name__ == "__main__":

app/router/__init__.py

@@ -1,7 +1,6 @@
 from fastapi import APIRouter
 
-# Create the router.
-router = APIRouter()
+from .v1 import all, confirmed, deaths, recovered
 
 # The routes.
-from . import latest, sources, locations  # isort:skip
+from .v2 import latest, sources, locations  # isort:skip

app/router/v1/__init__.py

@@ -0,0 +1,3 @@
+from fastapi import APIRouter
+
+router = APIRouter()

app/router/v1/all.py

@@ -0,0 +1,19 @@
+from ...services.location.jhu import get_category
+from . import router
+
+
+@router.get("/all")
+def all():
+    # Get all the categories.
+    confirmed = get_category("confirmed")
+    deaths = get_category("deaths")
+    recovered = get_category("recovered")
+
+    return {
+        # Data.
+        "confirmed": confirmed,
+        "deaths": deaths,
+        "recovered": recovered,
+        # Latest.
+        "latest": {"confirmed": confirmed["latest"], "deaths": deaths["latest"], "recovered": recovered["latest"],},
+    }

app/router/v1/confirmed.py

@@ -0,0 +1,9 @@
+from ...services.location.jhu import get_category
+from . import router
+
+
+@router.get("/confirmed")
+def confirmed():
+    confirmed = get_category("confirmed")
+
+    return confirmed

app/router/v1/deaths.py

@@ -0,0 +1,9 @@
+from ...services.location.jhu import get_category
+from . import router
+
+
+@router.get("/deaths")
+def deaths():
+    deaths = get_category("deaths")
+
+    return deaths

app/router/v1/recovered.py

@@ -0,0 +1,9 @@
+from ...services.location.jhu import get_category
+from . import router
+
+
+@router.get("/recovered")
+def recovered():
+    recovered = get_category("recovered")
+
+    return recovered