pyapiutils 0.0.10__py3-none-any.whl

pyapiutils/__init__.py

@@ -0,0 +1,10 @@
+from .utils import Logging, ConfigUtil, RelDirs, ClientInfo, APIResponse
+
+__all__ = ["UTILS"]
+
+class UTILS:
+    Logging = Logging
+    ConfigUtil = ConfigUtil
+    ClientInfo = ClientInfo
+    RelDirs = RelDirs
+    APIResponse = APIResponse

pyapiutils/utils/__init__.py

@@ -0,0 +1,11 @@
+"""Docstring"""
+
+from .config import ConfigUtil
+from .infoui import ClientInfo
+from .reldir import RelDirs
+from .logger import Logging
+from .apires import APIResponse
+
+
+
+__all__ = ["ConfigUtil", "ClientInfo", "RelDirs", "Logging", "APIResponse"]

pyapiutils/utils/apires.py

@@ -0,0 +1,16 @@
+"""Docstring"""
+from typing import Any, Optional, Self
+from pydantic import BaseModel
+
+class APIResponse(BaseModel):
+    success: bool = True
+    message: str = "OK"
+    data: Optional[Any] = None
+
+    @classmethod
+    def from_res(cls, res: Any, message: Optional[str] = None) ->Self:
+        return cls(
+            success = True,
+            message = message or "request successful",
+            data = res
+        )

pyapiutils/utils/config.py

@@ -0,0 +1,50 @@
+"""Docstring"""
+from pathlib import Path
+from functools import lru_cache
+from typing import Optional, Union, Type, Any
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+__all__ = ["ConfigUtil"]
+
+class ConfigUtil:
+    def __init__(
+        self,
+        base: Any,
+        env: Optional[Union[str, Path]] = None,
+        secrets: Optional[Union[str, Path]] = None,
+        prefix: Optional[str] = None,
+    ):
+        self.base = base
+        self.env_path = env
+        self.secrets_path = secrets
+        self.prefix = prefix
+
+    @property
+    def config(self):
+        config = self.get_config(
+            self.base,
+            self.env_path,
+            self.secrets_path,
+            self.prefix,
+        )
+        return self.base.model_validate(config)
+
+    @classmethod
+    @lru_cache
+    def get_config(
+        cls,
+        base: Type[BaseSettings],
+        env: Optional[Union[str, Path]] = None,
+        secrets: Optional[Union[str, Path]] = None,
+        prefix: Optional[str] = None,
+    ):
+        class Config(base):
+            model_config = SettingsConfigDict(
+                env_prefix=prefix or "",
+                env_file=str(env) if env else None,
+                env_file_encoding="utf-8",
+                extra="ignore",
+                secrets_dir=str(secrets) if secrets else None,
+            )
+
+        return Config()

pyapiutils/utils/infoui.py

@@ -0,0 +1,35 @@
+import user_agents
+from fastapi import Request
+
+class ClientInfo:
+    @staticmethod
+    def client_ip(request: Request) -> str:
+        return (
+            request.headers.get("CF-Connecting-IP")  # Cloudflare
+            or request.headers.get("True-Client-IP") # Akamai / proxies
+            or request.headers.get("X-Forwarded-For", "").split(",")[0].strip()
+            or request.headers.get("X-Real-IP")
+            or (request.client.host if request.client else "unknown")
+        )
+    
+    @staticmethod
+    def user_agent(request: Request) -> str:
+        """
+        Returns a clean parsed User-Agent string like 'Chrome 122 on Windows 10'.
+        """
+        ua_string = (
+            request.headers.get("X-Real-User-Agent")
+            or request.headers.get("X-Device-User-Agent")
+            or request.headers.get("X-Original-User-Agent")
+            or request.headers.get("User-Agent")
+            or "unknown"
+        )
+
+        ua = user_agents.parse(ua_string)
+
+        browser = f"{ua.browser.family} {ua.browser.version_string}".strip()
+        os = f"{ua.os.family} {ua.os.version_string}".strip()
+        device = ua.device.family or "Unknown Device"
+
+        # Return a clean single string
+        return f"{browser} on {os} ({device})"

pyapiutils/utils/logger.py

@@ -0,0 +1,80 @@
+"""Docstring"""
+import logging, sys
+
+class Logging:
+    KAFKA_SILENT_LIST=["aiokafka"]
+    GAIMS_SILENT_LIST=["aiokafka", "botocore", "s3transfer", "urllib3"]
+    @staticmethod
+    def setup_basic(level=logging.INFO):
+        root = logging.getLogger()
+        if root.handlers:
+            root.handlers.clear()
+        root.setLevel(level)
+
+        formatter = logging.Formatter(
+            "%(asctime)s | %(levelname)s | %(name)s | %(message)s"
+        )
+
+        handler = logging.StreamHandler(sys.stdout)
+        handler.setFormatter(formatter)
+        handler.setLevel(level)
+
+        logging.basicConfig(
+            level=level,
+            handlers=[handler],
+            force=True,  # override any existing config
+        )
+
+    @staticmethod
+    def setup_process(level=logging.INFO):
+        root = logging.getLogger()
+        if root.handlers:
+            root.handlers.clear()
+        root.setLevel(level)
+
+        formatter = logging.Formatter(
+            "%(asctime)s | %(levelname)s | %(processName)s | %(name)s | %(message)s"
+        )
+
+        handler = logging.StreamHandler(sys.stdout)
+        handler.setFormatter(formatter)
+        handler.setLevel(level)
+
+        logging.basicConfig(
+            level=level,
+            handlers=[handler],
+            force=True,
+        )
+
+    @staticmethod
+    def setup_service(service:str, level=logging.INFO):
+        root = logging.getLogger()
+        if root.handlers:
+            root.handlers.clear()
+        root.setLevel(level)
+
+        formatter = logging.Formatter(
+            "%(asctime)s | %(levelname)s | %(service)s | %(processName)s | %(name)s:%(lineno)d | %(message)s"
+        )
+
+        handler = logging.StreamHandler(sys.stdout)
+        handler.setFormatter(formatter)
+        handler.setLevel(level)
+
+        class ServiceFilter(logging.Filter):
+            def filter(self, record):
+                record.service = service
+                return True
+
+        handler.addFilter(ServiceFilter())
+
+        logging.basicConfig(
+            level=level,
+            handlers=[handler],
+            force=True,
+        )
+
+    @staticmethod
+    def silent_loglist(names: list[str], level=logging.ERROR):
+        for name in names:
+            logging.getLogger(name).setLevel(level)

pyapiutils/utils/reldir.py

@@ -0,0 +1,21 @@
+from pathlib import Path
+
+class RelDirs:
+    def __init__(self, path_str):
+        self.path = self._path(path_str)
+        self.dir = (
+            self.path 
+            if self.path.is_dir() 
+            else self.path.parent
+        )
+         
+    def _path(self, path_str):
+        """
+        Doc String
+        """
+        path = Path(path_str).resolve()
+        cwd = Path.cwd().resolve()
+        try:
+            return path.relative_to(cwd)
+        except ValueError:
+            return path

pyapiutils-0.0.10.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: pyapiutils
+Version: 0.0.10
+Summary: 
+Author: sharmauksa
+Author-email: sharmaumesh791@gmail.com
+Requires-Python: >=3.14,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Description-Content-Type: text/markdown
+
+# pyapiutils
+
+**pyapiutils** is a lightweight Python library for fastapi utilities.
+
+## Features
+
+- 🔐 Utilities to create alembic migration
+## Installation
+
+You can install the package via pip:
+
+```bash
+pip install pyapilib

pyapiutils-0.0.10.dist-info/RECORD

@@ -0,0 +1,10 @@
+pyapiutils/__init__.py,sha256=EkQkmMbWoG1faiUV77vf7TjInIcikL0popAx3eWX-qY,246
+pyapiutils/utils/__init__.py,sha256=-HOhMYTiSubnFPCtIhT9JYuYETfvAtA2s8IIOCPskpI,255
+pyapiutils/utils/apires.py,sha256=BAiIy3T8ZuD2prYnsKVVB_DTDbje_8JdJhDA31Bks7c,421
+pyapiutils/utils/config.py,sha256=4Jxfox5qx63PGabzABP1LgRCD6anizWn-ip0TK3sM3Q,1414
+pyapiutils/utils/infoui.py,sha256=yI5T4lYxKNOutbxzLBcHzMjAnfl9bld54s2bIjolc58,1299
+pyapiutils/utils/logger.py,sha256=I9f9a4xpcsEMD0fIibRT0ZqkeIaPQwCt9UK9L7LsKAc,2345
+pyapiutils/utils/reldir.py,sha256=jiSBC8sFJeerMckD1edIOyXxrK8o5O28s9QR1HL7B9k,522
+pyapiutils-0.0.10.dist-info/METADATA,sha256=4IAUkvSPnTQDgUrNiES7yREOIVeevD0BT7UWgkWrke4,519
+pyapiutils-0.0.10.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
+pyapiutils-0.0.10.dist-info/RECORD,,

pyapiutils-0.0.10.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.4.0
+Root-Is-Purelib: true
+Tag: py3-none-any