fastapi-basic 0.0.8__py3-none-any.whl → 0.0.10__py3-none-any.whl

fastapi_basic/base_config.py

@@ -7,4 +7,11 @@ class BaseConfig(BaseSettings):
     OPENAPI_URL: str|None = '/openapi.json'
 
     # Logging config
-    LOGGER_NAME: str|None = 'uvicorn'
+    LOGGER_NAME: str|None = 'uvicorn'
+
+    # AWS
+    AWS_ACCESS_KEY_ID: str = ""
+    AWS_SECRET_KEY: str = ""
+    AWS_REGION: str = ""
+    AWS_PARAMETER_PATH_PREFIX: str = ""
+    AWS_LOGGROUP_NAME: str = ""

fastapi_basic/base_factory.py

@@ -2,10 +2,13 @@ from abc import ABCMeta, abstractmethod
 from functools import lru_cache
 import os, dotenv
 
+import watchtower
 from fastapi import FastAPI, Request
+from fastapi.middleware.cors import CORSMiddleware
 from starlette.concurrency import iterate_in_threadpool
 import logging
 
+from .ext.aws import init_app as init_aws_app
 from .const import LOG_DEFAULT_LOGGER_NAME, LOG_FMT
 from .utils import update_dict_with_cast
 
@@ -34,6 +37,15 @@ class BaseFactory(metaclass=ABCMeta):
         logger.addHandler(stream_handler)
         return logger
 
+    def __setup_aws_cloud_log(self, app):
+        if app.state.aws_session and app.state.config.get("AWS_LOGGROUP_NAME"):
+            logs_client = app.state.aws_session.client("logs")
+            watchtower_handler = watchtower.CloudWatchLogHandler(
+                log_group_name=app.state.config.get("AWS_LOGGROUP_NAME"),
+                boto3_client=logs_client, create_log_group=True)
+            watchtower_handler.setFormatter(logging.Formatter(LOG_FMT))
+            app.logger.addHandler(watchtower_handler)
+
     def create_app(self):
         """
         Create an application instance.
@@ -43,7 +55,16 @@ class BaseFactory(metaclass=ABCMeta):
         app = FastAPI(docs_url=app_config.get('DOCS_URL'), redoc_url=app_config.get('REDOC_URL'), openapi_url=app_config.get('OPENAPI_URL'))
         app.state.config = app_config
 
+        app.add_middleware(
+            CORSMiddleware,
+            allow_origins=['*'],
+            allow_credentials=True,
+            allow_methods=['*'],
+            allow_headers=['*'],
+        )
         self.__setup_main_logger(app, logger_name=app.state.config.get('LOGGER_NAME', LOG_DEFAULT_LOGGER_NAME), level=logging.DEBUG)
+        app.state.aws_session = init_aws_app(app)
+        self.__setup_aws_cloud_log(app)
 
         @app.middleware("http")
         async def handle_request_headers(request: Request, call_next):

fastapi_basic/ext/aws/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: UTF-8 -*-
+import boto3
+
+from .const import AWS_CONF_KEY
+
+
+def init_app(app):
+    if not all([app.state.config.get(key) for key in AWS_CONF_KEY]):
+        # pylint: disable=no-member
+        app.logger.info("Lack AWS credential keys, ignore connect to AWS")
+        return None
+
+    aws_session = boto3.session.Session(
+        aws_access_key_id=app.state.config.AWS_ACCESS_KEY_ID,
+        aws_secret_access_key=app.state.config.AWS_SECRET_KEY,
+        region_name=app.state.config.AWS_REGION
+    )
+
+    # This should be logging when create Logging handlers,
+    # But we have too many CloudWatchLogHandler, only print once here.
+    if not getattr(app.state.config, "AWS_LOGGROUP_NAME"):
+        app.logger.info("Lack AWS configuration keys, ignore AWS CloudWatch log handlers")
+
+    return aws_session

fastapi_basic/ext/aws/const.py

@@ -0,0 +1 @@
+AWS_CONF_KEY = ["AWS_ACCESS_KEY_ID", "AWS_SECRET_KEY", "AWS_REGION"]

{fastapi_basic-0.0.8.dist-info → fastapi_basic-0.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi_basic
-Version: 0.0.8
+Version: 0.0.10
 Summary: A short description of your module
 Home-page: https://github.com/szx21023/fastapi-base
 Author: szx21023
@@ -12,6 +12,8 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 Requires-Dist: annotated-types==0.7.0
 Requires-Dist: anyio==4.9.0
+Requires-Dist: boto3==1.37.36
+Requires-Dist: botocore==1.37.36
 Requires-Dist: certifi==2025.1.31
 Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: click==8.1.8
@@ -19,17 +21,22 @@ Requires-Dist: dotenv==0.9.9
 Requires-Dist: fastapi==0.115.12
 Requires-Dist: h11==0.14.0
 Requires-Dist: idna==3.10
+Requires-Dist: jmespath==1.0.1
 Requires-Dist: pydantic==2.11.3
 Requires-Dist: pydantic_core==2.33.1
+Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: python-dotenv==1.1.0
 Requires-Dist: python-multipart==0.0.20
 Requires-Dist: requests==2.32.3
+Requires-Dist: s3transfer==0.11.5
+Requires-Dist: six==1.17.0
 Requires-Dist: sniffio==1.3.1
 Requires-Dist: starlette==0.46.1
 Requires-Dist: typing-inspection==0.4.0
 Requires-Dist: typing_extensions==4.13.1
 Requires-Dist: urllib3==2.3.0
 Requires-Dist: uvicorn==0.34.0
+Requires-Dist: watchtower==3.4.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

fastapi_basic-0.0.10.dist-info/RECORD

@@ -0,0 +1,12 @@
+fastapi_basic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_basic/base_config.py,sha256=nimiiK5LRY9kmx3dBDbN7teO4R8E423-c2iyq9WMcCg,442
+fastapi_basic/base_factory.py,sha256=wrQ6YYyqyEme7Hzkc_4HSddQzFZdE8GUsmUQsORTkI4,3255
+fastapi_basic/const.py,sha256=UA7-Eefu_dbWpbFn09Ei_BPb903SExnCgVbnm8_3ALE,99
+fastapi_basic/utils.py,sha256=8ympyQIXsKkxLILTI_7ug85vmKWYKqX0mpADjgHekgU,306
+fastapi_basic/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_basic/ext/aws/__init__.py,sha256=N_cwnbv1N-F1SY6NenBOTZe20zGaKFu3UXAu17hFAXY,816
+fastapi_basic/ext/aws/const.py,sha256=Mmb6lo11aZZDAVy-nK-v_JxtVPPKYUo9GB4ihH7XYuM,68
+fastapi_basic-0.0.10.dist-info/METADATA,sha256=cRMHpw2uH7Ub-vDyQogQmPu_vNDMt5Bx_3MG7aaYLBg,1741
+fastapi_basic-0.0.10.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+fastapi_basic-0.0.10.dist-info/top_level.txt,sha256=Q9PdwWxaB4dy135MQHiroRYOqArdUSaIeEkzYinN6W0,14
+fastapi_basic-0.0.10.dist-info/RECORD,,

fastapi_basic-0.0.8.dist-info/RECORD

@@ -1,9 +0,0 @@
-fastapi_basic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_basic/base_config.py,sha256=_AMa1BDpCw0e00BUYKzOGVBjHrbAR5WfIWwlRS_Dmug,273
-fastapi_basic/base_factory.py,sha256=3SFewCi2SKpvAZp5kjpGYz_hTxqS_WJa0ecEBicq9mc,2332
-fastapi_basic/const.py,sha256=UA7-Eefu_dbWpbFn09Ei_BPb903SExnCgVbnm8_3ALE,99
-fastapi_basic/utils.py,sha256=8ympyQIXsKkxLILTI_7ug85vmKWYKqX0mpADjgHekgU,306
-fastapi_basic-0.0.8.dist-info/METADATA,sha256=w9LeU9tlfQRfa2whpukhvTotXOZDDdtxC4A1r8nuxi4,1508
-fastapi_basic-0.0.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-fastapi_basic-0.0.8.dist-info/top_level.txt,sha256=Q9PdwWxaB4dy135MQHiroRYOqArdUSaIeEkzYinN6W0,14
-fastapi_basic-0.0.8.dist-info/RECORD,,