first commit

Author: Athira C

.env

@@ -0,0 +1,10 @@
+DB_USER = "postgres"
+DB_PASS = "123456"
+DB_HOST = "localhost"
+TS_DB_NAME = "flaskdemo"
+DB_DRIVER = "postgres"
+TS_SCHEMA = "testflask"
+POOL_SIZE = 20
+TYPE=prod
+PORT=5000
+SECRET_KEY = "mlkjhgfdghjkhgfdghjkjhgfcd"

.gitignore

@@ -0,0 +1,10 @@
+web/techstack/__pycache__
+common/__pycache__
+web/swagger/__pycache__
+web/__pycache__
+repository/__pycache__
+.idea/
+middleware/__pycache__
+.vscode/
+tests/__pycache__/
+migrations/

README.md

@@ -0,0 +1,45 @@
+
+# Tech Stack App
+
+This is the basic structure of the Flask App. Folder Structure as well as basic code is included with this app. The Swagger part is also present with this basic app.
+
+
+How to Setup the Basic Flask App
+```
+- Create a virtual enviornment and activate the enviornment
+- pip install -r requirements.txt
+- cd web
+- python .\techstack_app.py
+
+```
+
+The basic flask app will be open in http://127.0.0.1:5000
+The basic flask swagger api  will be open in http://127.0.0.1:5000/apidocs/
+
+How to upgrade the database
+
+```
+- Create a folder 'migrations --mkdir migrations
+- cd migrations
+- alembic init alembic
+
+```
+it will create a alembic folder as well as alembic.ini
+
+- Edit the alembic.ini file by changing the sqlalchemy.url
+
+`sqlalchemy.url = postgresql+psycopg2://{username}:{password}@{hostname}/{dbname}`
+
+- In alembic/env.py Add
+
+`sys.path.append(os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))), "repository"))`
+
+`import models`
+
+`target_metadata = models.Base.metadata`
+-
+```
+- alembic revision --autogenerate -m {proper message}
+- alembic upgrade head
+```
+

common/app_blueprint.py

@@ -0,0 +1,6 @@
+from flask import Blueprint
+
+
+class AppBP(Blueprint):
+    def __init__(self, name, import_name):
+        super().__init__(name, import_name)

common/app_constants.py

@@ -0,0 +1,12 @@
+class AppConstants:
+    CODE_OK = 200
+    CODE_INVALID_REQUEST = 400
+    CODE_UNAUTHORISED = 401
+    CODE_FORBIDDEN = 403
+    CODE_INTERNAL_SERVER_ERROR = 500
+    CODE_NOT_IMPLEMENTED = 501
+    CODE_BAD_GATEWAY = 502
+    CODE_SERVICE_UNAVAILABLE = 503
+    CODE_GATEWAY_TIMEOUT = 504
+    SUCCESSFULL_STATUS_CODE = "200"
+    UNSUCCESSFULL_STATUS_CODE = "500"

common/app_response.py

@@ -0,0 +1,39 @@
+from app_constants import AppConstants
+from string_table import AppMessages
+from structlogconfig import log_config
+
+logdata = log_config()
+
+
+class AppResponse(dict):
+    def __init__(
+        self,
+        code_param=AppConstants.CODE_INTERNAL_SERVER_ERROR,
+        data_param={},
+        message_param=AppMessages.FAILED,
+        status_param=AppMessages.FALSE,
+    ):
+        dict.__init__(
+            self,
+            code=code_param,
+            data=data_param,
+            message=message_param,
+            status=status_param,
+        )
+
+    def set_response(self, code_param, data_param, message_param, status_param):
+        self["code"] = code_param
+        self["data"] = data_param
+        self["message"] = message_param
+        self["status"] = status_param
+        if code_param == 200:
+            try:
+                if "User is created with given name" in data_param.get("Success"):
+                    data_param = data_param.get("Success").split("Generated")[0]
+                elif "User is loggedinn" in data_param.get("Success"):
+                    data_param = data_param.get("Success").split("and token")[0]
+            except:
+                pass
+            logdata.info(data_param, message=message_param, status_code=status_param)
+        else:
+            logdata.error(data_param, message=message_param, status_code=status_param)

common/log_data.py

@@ -0,0 +1,43 @@
+import logging
+
+
+class ApplicationLogger:
+    def info(msg):
+        return logging.getLogger("info_application").info(msg)
+
+    def error(msg):
+        return logging.getLogger("error_application").error(msg)
+
+    def debug(msg):
+        return logging.getLogger("debug_application").debug(msg)
+
+    def warn(msg):
+        return logging.getLogger("warning_application").warn(msg)
+
+
+class ThirdPartyLogger:
+    def info(msg):
+        return logging.getLogger("info_third_party").info(msg)
+
+    def error(msg):
+        return logging.getLogger("error_third_party").error(msg)
+
+    def debug(msg):
+        return logging.getLogger("debug_third_party").debug(msg)
+
+    def warn(msg):
+        return logging.getLogger("warning_third_party").warn(msg)
+
+
+class AuditLogger:
+    def info(msg):
+        return logging.getLogger("info_audit").info(msg)
+
+    def error(msg):
+        return logging.getLogger("error_audit").error(msg)
+
+    def debug(msg):
+        return logging.getLogger("debug_audit").debug(msg)
+
+    def warn(msg):
+        return logging.getLogger("warning_audit").warn(msg)

common/string_table.py

@@ -0,0 +1,10 @@
+class AppMessages:
+    FAILED = "failed"
+    FALSE = False
+    OPERATION_SUCCESS = "Operation Successfully Completed"
+    OPERATION_FAILED = "Operation Failed"
+    INTERNAL_ERROR = "Internal Server Error Occurred"
+    SOMETHING_WENT_WRONG = "Something went wrong, please try again"
+    INVALID_JWT = "Invalid jwt token"
+    UNAUTHORIZED_REQUEST = "Unauthorized request"
+    AUTHENTICATION_FAILED = "Authentication Failed"

common/structlogconfig.py

@@ -0,0 +1,6 @@
+import structlog
+
+
+def log_config():
+    log = structlog.get_logger()
+    return log