Merge pull request #28 from bybatkhuu/develop

Author: bybatkhuu

.editorconfig

@@ -1,23 +1,26 @@
 root = true
 
 [*]
+indent_style = tab
+indent_size = 4
 charset = utf-8
-trim_trailing_whitespace = true
 end_of_line = lf
+trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.py]
 indent_style = space
-indent_size = 4
 
-[*.{yml,yaml}]
+[*.{yaml,yml}]
 indent_style = space
 indent_size = 2
 
-[*.{js,json,sh}]
-indent_style = tab
+[*.bat]
+end_of_line = crlf
 
 [*.md]
 indent_style = space
-indent_size = 4
 trim_trailing_whitespace = false
+
+[LICENSE]
+insert_final_newline = false

.github/release.yml

@@ -43,6 +43,7 @@ changelog:
     - title: 👷 CI/CD
       labels:
         - ci
+        - cicd
         - ci/cd
         - build
         - deploy

README.md

@@ -22,7 +22,6 @@ It is a `Loguru` based custom logging package for python projects.
 - Custom logging **formats**
 - **Multiprocess** compatibility (Linux, macOS - 'fork')
 - Add custom **handlers**
-- **FastAPI** HTTP access logging **middleware**
 - **Base** logging module
 - Support **Pydantic-v1** and **Pydantic-v2**
 
@@ -211,157 +210,12 @@ Traceback (most recent call last):
 ZeroDivisionError: division by zero
 ```
 
-### **Advanced (FastAPI)**
+### **FastAPI**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/configs/logger.yml):
+Checkout `beans_logging_fastapi` package: <https://github.com/bybatkhuu/module.fastapi-logging>
 
-```yaml
-logger:
-  app_name: "fastapi-app"
-  level: "TRACE"
-  use_diagnose: false
-  stream:
-    use_color: true
-    use_icon: false
-    format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
-    std_handler:
-      enabled: true
-  file:
-    logs_dir: "./logs"
-    rotate_size: 10000000 # 10MB
-    rotate_time: "00:00:00"
-    backup_count: 90
-    log_handlers:
-      enabled: true
-      format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
-      log_path: "{app_name}.std.all.log"
-      err_path: "{app_name}.std.err.log"
-    json_handlers:
-      enabled: true
-      use_custom: false
-      log_path: "json/{app_name}.json.all.log"
-      err_path: "json/{app_name}.json.err.log"
-  intercept:
-    auto_load:
-      enabled: true
-      only_base: false
-      ignore_modules: []
-    include_modules: []
-    mute_modules: ["uvicorn.access", "uvicorn.error"]
-  extra:
-    http_std_debug_format: '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    http_std_msg_format: '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-    http_file_enabled: true
-    http_log_path: "http/{app_name}.http.access.log"
-    http_err_path: "http/{app_name}.http.err.log"
-    http_json_enabled: true
-    http_json_path: "json.http/{app_name}.json.http.access.log"
-    http_json_err_path: "json.http/{app_name}.json.http.err.log"
-```
-
-[**`.env`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/.env):
-
-```sh
-ENV=development
-DEBUG=true
-```
-
-[**`logger.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/logger.py):
-
-```python
-from beans_logging import Logger, LoggerLoader
-from beans_logging.fastapi import add_http_file_handler, add_http_file_json_handler
-
-
-logger_loader = LoggerLoader()
-logger: Logger = logger_loader.load()
-
-if logger_loader.config.extra.http_file_enabled:
-    add_http_file_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_log_path,
-        err_path=logger_loader.config.extra.http_err_path,
-    )
-
-if logger_loader.config.extra.http_json_enabled:
-    add_http_file_json_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_json_path,
-        err_path=logger_loader.config.extra.http_json_err_path,
-    )
-```
-
-[**`main.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/main.py):
-
-```python
-from typing import Union
-from contextlib import asynccontextmanager
-
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException
-from fastapi.responses import RedirectResponse
-
-load_dotenv()
-
-from beans_logging.fastapi import HttpAccessLogMiddleware
-
-from logger import logger, logger_loader
-from __version__ import __version__
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    logger.info("Preparing to startup...")
-    logger.success("Finished preparation to startup.")
-    logger.info(f"API version: {__version__}")
-
-    yield
-    logger.info("Praparing to shutdown...")
-    logger.success("Finished preparation to shutdown.")
-
-app = FastAPI(lifespan=lifespan, version=__version__)
-app.add_middleware(
-    HttpAccessLogMiddleware,
-    has_proxy_headers=True,
-    debug_format=logger_loader.config.extra.http_std_debug_format,
-    msg_format=logger_loader.config.extra.http_std_msg_format,
-)
-
-@app.get("/")
-def root():
-    return {"Hello": "World"}
-```
-
-Run the [**`examples/advanced`**](https://github.com/bybatkhuu/module.python-logging/tree/main/examples/advanced):
-
-```sh
-cd ./examples/advanced
-# Install python dependencies for examples:
-pip install -r ./requirements.txt
-
-uvicorn main:app --host=0.0.0.0 --port=8000
-```
-
-**Output**:
-
-```txt
-[2023-09-01 00:00:00.000 +09:00 | TRACE | beans_logging._base:576]: Intercepted modules: ['watchfiles.watcher', 'dotenv', 'asyncio', 'dotenv.main', 'watchfiles.main', 'concurrent.futures', 'uvicorn', 'fastapi', 'concurrent', 'watchfiles']; Muted modules: ['uvicorn.access', 'uvicorn.error'];
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:76]: Started server process [17146]
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:46]: Waiting for application startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:21]: Preparing to startup...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:22]: Finished preparation to startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:23]: API version: 0.0.1-000000
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:60]: Application startup complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:218]: Uvicorn running on http://0.0.0.0:9000 (Press CTRL+C to quit)
-[2023-09-01 00:00:00.000 +09:00 | DEBUG | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1"
-[2023-09-01 00:00:00.000 +09:00 | OK    | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1" 200 17B 0.7ms
-^C[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:264]: Shutting down
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:65]: Waiting for application shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:26]: Praparing to shutdown...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:27]: Finished preparation to shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:76]: Application shutdown complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:86]: Finished server process [17146]
-```
+- FastAPI HTTP access logging middleware
+- Install with pip: `pip install -U beans-logging[fastapi]` or `pip install -U beans-logging-fastapi`
 
 ---
 
@@ -442,3 +296,4 @@ logger:
 - <https://github.com/Delgan/loguru>
 - <https://loguru.readthedocs.io/en/stable/api/logger.html>
 - <https://loguru.readthedocs.io/en/stable/resources/recipes.html>
+- <https://github.com/bybatkhuu/module.fastapi-logging>