fix python lint issue

Signed-off-by: Lu Ken <[email protected]>

README.md

@@ -10,4 +10,6 @@
 ```shell
 export PYTHONPATH=<repo_dir>/src
 uvicorn gentrade-server.main:app --reload
-```
+or
+python -m gentrade-server.main
+```

src/gentrade-server/auth.py → src/gentrade_server/auth.py

@@ -1,12 +1,18 @@
+"""
+Authorization module
+"""
 from fastapi import Security, HTTPException, status
 from fastapi.security import APIKeyHeader
 from .db import check_api_key, get_user_from_api_key
 
 api_key_header = APIKeyHeader(name="X-API-Key")
 
-def get_user(api_key_header: str = Security(api_key_header)):
-    if check_api_key(api_key_header):
-        user = get_user_from_api_key(api_key_header)
+def get_user(header: str = Security(api_key_header)):
+    """
+    Get user from the API key
+    """
+    if check_api_key(header):
+        user = get_user_from_api_key(header)
         return user
     raise HTTPException(
         status_code=status.HTTP_401_UNAUTHORIZED,

src/gentrade-server/db.py → src/gentrade_server/db.py

@@ -1,3 +1,6 @@
+"""
+Database
+"""
 api_keys = {
     "e54d4431-5dab-474e-b71a-0db1fcb9e659": "7oDYjo3d9r58EJKYi5x4E8",
     "5f0c7127-3be9-4488-b801-c7b6415b45e9": "mUP7PpTHmFAkxcQLWKMY8t"
@@ -13,7 +16,13 @@
 }
 
 def check_api_key(api_key: str):
+    """
+    Check whether API key valid
+    """
     return api_key in api_keys
 
 def get_user_from_api_key(api_key: str):
+    """
+    Get the user from the given API key
+    """
     return users[api_keys[api_key]]

src/gentrade-server/main.py → src/gentrade_server/main.py

@@ -1,3 +1,5 @@
+import uvicorn
+
 from fastapi import FastAPI, Depends
 from .routers import secure, public
 from .auth import get_user
@@ -13,3 +15,6 @@
     prefix="/api/v1/secure",
     dependencies=[Depends(get_user)]
 )
+
+if __name__ == '__main__':
+    uvicorn.run(app, host="0.0.0.0", port=8000)

src/gentrade-server/routers/public.py → src/gentrade_server/routers/public.py

@@ -1,8 +1,13 @@
+"""
+Public result API interfaces
+"""
 from fastapi import APIRouter
 
-
 router = APIRouter()
 
 @router.get("/")
 async def get_testroute():
-    return "OK"
+    """
+    Test public interface
+    """
+    return "OK"

src/gentrade-server/routers/secure.py → src/gentrade_server/routers/secure.py

@@ -1,8 +1,14 @@
+"""
+Secure API interface
+"""
 from fastapi import APIRouter, Depends
 from ..auth import get_user
 
 router = APIRouter()
 
 @router.get("/")
 async def get_testroute(user: dict = Depends(get_user)):
-    return user
+    """
+    Test secure interface
+    """
+    return user