Packaging Python API for right import

Author: flavienbwk

.env.example

@@ -1,4 +1,4 @@
-FLASK_API_VERSION="1.2.0"
+FLASK_API_VERSION="1.3.0"
 FLASK_SERVER_NAME="My API Project"
 FLASK_SERVER_DESCRIPTION="Dockerized Flask API boilerplate using an LDAP and token-based authentication"
 FLASK_SECRET_KEY="Some secret key"

README.md

@@ -20,7 +20,8 @@
 - [Logging and logs rotation](./api/app/src/utils/Logger.py#L12)
 - [Choose](./app/app/src/App.js#L65) between sidebar and navbar (or use both !)
 - Responsive design
-- [Production](./prod.docker-compose.yml) and [development](./docker-compose.yml) builds
+- [Development](./docker-compose.yml), [production](./prod.docker-compose.yml) and [Kubernetes](./k8s) builds
+- State-of-the-art [Python packaging](./api/app/setup.py)
 
 ## API documentation
 

api/Dockerfile

@@ -4,9 +4,9 @@ FROM python:3.7-alpine
 RUN apk update && apk add openldap-dev libc-dev gcc g++
 
 # psycopg2 requirements
-RUN apk add libpq python3-dev musl-dev postgresql-dev
+RUN apk add libpq python3-dev py3-pip musl-dev postgresql-dev
 
-COPY ./requirements.txt /requirements.txt
+COPY ./app/requirements.txt /requirements.txt
 RUN pip install -r /requirements.txt
 
 COPY ./entrypoint.sh /entrypoint.sh

api/app/.gitignore

@@ -1 +1,4 @@
 __pycache__/
+build/
+dist/
+*.egg-info

api/app/main.py renamed to api/app/my_app/__init__.py

@@ -1,9 +1,11 @@
+from time import sleep
 from flask_migrate import Migrate, MigrateCommand
 from flask_script import Manager
 
-from src.routes import blueprint
-from src.app import create_app, database
-from src.utils.ApiResponse import ApiResponse
+from .routes import blueprint
+from .app import create_app, database, logger
+from .utils.ApiResponse import ApiResponse
+
 
 # Initialization
 
@@ -13,14 +15,23 @@
 
 manager = Manager(app)
 migrate = Migrate(app, database.getDatabase(), "/migrations")
+
+## Waiting for database to be available
+while database.isDatabaseAvailable(app) is False:
+    logger.warning("Database unreachable. Waiting for 3 seconds to be up...")
+    sleep(3.0)
+logger.info("Database is up and running ✓")
+database.initDatabase(app)
 manager.add_command('db', MigrateCommand)
 
+
 # Commands
 
 @manager.command
 def run():
     app.run(debug=True, port=5000, host="0.0.0.0")
 
+
 # System functions
 
 @app.after_request
@@ -32,5 +43,6 @@ def after_request(response):
     response, http_code = ApiResponse.formatFlaskResponse(response)
     return app.make_response((response, http_code))
 
+
 if __name__ == '__main__':
-    manager.run()
+    manager.run()

api/app/my_app/__main__.py

@@ -0,0 +1,6 @@
+# This file allows "my-app" package to be run 
+# via `python -m` command line. 
+from . import manager
+
+if __name__ == '__main__':
+    manager.run()

api/app/src/app.py renamed to api/app/my_app/app.py

@@ -1,5 +1,4 @@
 import os
-from time import sleep
 from flask import Flask
 
 from .utils.Logger import Logger
@@ -12,7 +11,7 @@
 FLASK_LEVEL = os.environ.get("FLASK_LEVEL", "dev")
 
 logger = Logger()
-database = Database()
+database = Database(logger)
 
 def page_not_found(e):
     apiResponse = ApiResponse()
@@ -25,11 +24,4 @@ def create_app():
     app.register_error_handler(404, page_not_found)
     app.config.from_object(config_by_name[FLASK_LEVEL])
     os.environ["FLASK_ENV"] = config_by_name[FLASK_LEVEL].FLASK_ENV
-
-    # Waiting for database to be available
-    while database.isDatabaseAvailable(app) is False:
-        logger.warning("Database unreachable. Waiting for 3 seconds to be up...")
-        sleep(3.0)
-    logger.info("Database is up and running ✓")
-    database.initDatabase(app)
     return app

api/app/src/config.py renamed to api/app/my_app/config.py

@@ -1,12 +1,8 @@
 from flask import request, escape
 from flask_restplus import Resource, Namespace, fields
 
-from ..utils.Logger import Logger
-
 from ..service.auth_service import AuthService, requires_authentication
 
-logger = Logger()
-
 # DTOs
 
 api = Namespace('Auth', description='Authentication-related operations')