first commit

Author: anqorithm

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+          
+      - name: Install dependencies
+        run: npm install -g conventional-changelog-conventionalcommits @semantic-release/git semantic-release
+          
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          npx semantic-release --branches main 

.gitignore

@@ -0,0 +1,34 @@
+.idea
+.ipynb_checkpoints
+.mypy_cache
+.vscode
+__pycache__
+.pytest_cache
+htmlcov
+dist
+logs
+site
+.coverage*
+coverage.xml
+.netlify
+test.db
+log.txt
+Pipfile.lock
+env3.*
+env
+docs_build
+site_build
+venv
+docs.zip
+archive.zip
+
+# vim temporary files
+*~
+.*.sw?
+.cache
+
+# macOS
+.DS_Store
+Python-3.13.1
+dist
+Python-3.13.1.tar.xz

.releaserc.json

@@ -0,0 +1,10 @@
+{
+    "branches": [
+        "main"
+    ],
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github"
+    ]
+}

LICENSE

@@ -0,0 +1 @@
+ 

README.md

@@ -0,0 +1,3 @@
+from zlogger_kit.zlog import ZLog
+
+__all__ = ["ZLog"]

assets/zlogger-logo.svg

@@ -0,0 +1,32 @@
+from zlogger_kit.zlog import ZLog
+from zlogger_kit.models import ZLogConfig
+from examples.modules import Module
+
+config = ZLogConfig(
+    module=Module.AUTH.value,
+    json_format=False,
+    log_path="logs/auth",
+)
+logger = ZLog.init(config)
+
+logger.info("Starting authentication process", client_ip="192.168.1.100")
+logger.info("Login successful", user_id="user_123")
+logger.error(
+    "Login failed",
+    username="suspicious_user",
+    ip="10.0.0.5",
+    reason="Invalid credentials",
+)
+logger.warn(
+    "Failed login attempt",
+    username="suspicious_user",
+    ip="10.0.0.5",
+    reason="Invalid credentials",
+)
+logger.debug("Debug message", user_id="user_123")
+logger.warn(
+    "Failed login attempt",
+    username="suspicious_user",
+    ip="10.0.0.5",
+    reason="Invalid credentials",
+)

examples/__init__.py

@@ -0,0 +1,32 @@
+from fastapi import FastAPI
+from examples.modules import Module
+from zlogger_kit.middleware import ZLogMiddleware
+from zlogger_kit.zlog import ZLog
+from zlogger_kit.models import ZLogConfig
+from examples.routers.payment_router import router as payment_router
+
+app = FastAPI(title="Payment Service", description="API for payment processing")
+
+zlogger = ZLog.init(
+    ZLogConfig(
+        module=Module.PAYMENT.value,
+        log_path="logs",
+        time_zone="Asia/Riyadh",
+        json_format=True,
+    )
+)
+
+app.add_middleware(ZLogMiddleware, logger=zlogger)
+
+app.include_router(payment_router)
+
+
+@app.get("/health")
+async def health():
+    """Health check endpoint"""
+    return {"status": "healthy"}
+
+
+@app.get("/")
+async def root():
+    return {"message": "Welcome to the Payment Service API 💸"}

examples/example1.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+class Module(str, Enum):
+    AUTH = "AUTH"
+    DATABASE = "DATABASE"
+    CACHE = "CACHE"
+    NETWORK = "NETWORK"
+    PAYMENT = "PAYMENT"
+    REGISTRATION = "REGISTRATION"
+    SECURITY = "SECURITY"