log2fast-fastapi 0.1.0__tar.gz

log2fast_fastapi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Angel Daniel Sanchez Castillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

log2fast_fastapi-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+recursive-include docs *.md *.example
+recursive-include examples *.py
+recursive-include src/log2fast_fastapi *.py
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude .DS_Store

log2fast_fastapi-0.1.0/PKG-INFO

@@ -0,0 +1,287 @@
+Metadata-Version: 2.4
+Name: log2fast-fastapi
+Version: 0.1.0
+Summary: Advanced logging module for FastAPI - Designed for Solautyc Team internal use
+Author-email: Angel Daniel Sanchez Castillo <angeldaniel.sanchezcastillo@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Angel Daniel Sanchez Castillo
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/AngelDanielSanchezCastillo/log2fast-fastapi
+Project-URL: Documentation, https://github.com/AngelDanielSanchezCastillo/log2fast-fastapi/tree/main/docs
+Project-URL: Repository, https://github.com/AngelDanielSanchezCastillo/log2fast-fastapi
+Project-URL: Issues, https://github.com/AngelDanielSanchezCastillo/log2fast-fastapi/issues
+Keywords: fastapi,logging,rotation,colored-logs,structured-logging,middleware
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: FastAPI
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: httpx>=0.24.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: license-file
+
+# log2fast-fastapi
+
+🚀 Advanced logging module for FastAPI with file rotation, colored output, and environment-based auto-configuration
+
+> [!WARNING]
+> **Internal Use Notice**
+> 
+> This package is designed and maintained by the **Solautyc Team** for internal use. While it is publicly available, it may not work as expected in all environments or use cases outside of our specific infrastructure. We do not provide support or guarantees for external usage, and we are not responsible for any issues that may arise from using this package in other contexts.
+> 
+> Use at your own risk. Contributions and feedback are welcome, but compatibility with external environments is not guaranteed.
+
+## Features
+
+- 🎨 **Multiple Output Formats**: JSON (production), Colored (development), Structured (debugging), Simple (testing)
+- 🌍 **Environment-Based Configuration**: Automatic setup for dev, test, prod, and debug
+- 📦 **Module-Based Loggers**: Each module gets its own logger instance
+- 🔄 **File Rotation**: Automatic log file rotation with configurable size
+- 🔄 **Environment-Specific Logging**: Control which logs appear in which environments (prevent sensitive data leaks)
+- 🚀 **FastAPI Integration**: Middleware for automatic request/response logging with unique request IDs
+- 📊 **Structured Logging**: Add context data to any log message
+- 📊 **Context Injection**: Support for request_id, user_id, and custom context data
+- 🎯 **Zero Configuration**: Works out of the box with sensible defaults
+
+## 📚 Documentation
+
+- **[Usage Guide](docs/usage.md)** - Comprehensive usage guide with examples
+- **[File Management](docs/file_management.md)** - Complete guide on log rotation and storage (English)
+- **[Gestión de Archivos](docs/file_management_es.md)** - Guía completa de rotación y almacenamiento (Español)
+- **[Logger Best Practices](docs/logger_best_practices.md)** - Best practices for creating and naming loggers
+
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install log2fast-fastapi
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/AngelDanielSanchezCastillo/log2fast-fastapi.git
+cd log2fast-fastapi
+
+# Install in development mode
+pip install -e .
+
+# Or install with dev dependencies
+pip install -e ".[dev]"
+```
+
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from log2fast_fastapi import get_logger
+
+logger = get_logger(__name__)
+
+logger.info("Application started")
+logger.warning("This is a warning")
+logger.error("An error occurred")
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from log2fast_fastapi import RequestLoggingMiddleware, get_logger
+
+app = FastAPI()
+app.add_middleware(RequestLoggingMiddleware)
+
+logger = get_logger(__name__)
+
+@app.get("/")
+async def root():
+    logger.info("Root endpoint accessed")
+    return {"message": "Hello World"}
+```
+
+### Logging with Context
+
+```python
+from log2fast_fastapi import get_logger
+
+logger = get_logger(__name__)
+
+logger.info(
+    "User logged in",
+    extra_data={
+        "user_id": "12345",
+        "ip_address": "192.168.1.1"
+    }
+)
+```
+
+### Environment-Specific Logging (Prevent Sensitive Data Leaks!)
+
+```python
+# Logs ONLY in development/debug (NOT in production)
+logger.debug(
+    "Sensitive debug info",
+    extra_data={"password_hash": "...", "token": "..."},
+    only_in=["development", "debug"]
+)
+
+# Logs ONLY in production
+logger.info(
+    "Performance metrics",
+    extra_data={"response_time": 120},
+    only_in=["production"]
+)
+```
+
+## Configuration
+
+**Simple: Just set the environment in `.env`**
+
+```bash
+# That's it! Format and level auto-configure
+LOG_ENVIRONMENT=production
+```
+
+Auto-configuration by environment:
+
+| Environment | Auto Level | Auto Format |
+|------------|-----------|-------------|
+| `development` | INFO | colored |
+| `production` | WARNING | json |
+| `testing` | INFO | simple |
+| `debug` | DEBUG | colored |
+
+**Optional: Override defaults**
+
+
+```bash
+# Optional: Override auto-configuration
+LOG_LEVEL=DEBUG
+LOG_FORMAT=json
+LOG_FILE_SETTINGS__ENABLED=true
+```
+
+## Environment Presets
+
+### Development
+- Format: Colored console output
+- Level: INFO
+- Perfect for local development
+
+### Production
+- Format: JSON (structured)
+- Level: WARNING
+- Optimized for log aggregation tools
+
+### Testing
+- Format: Simple
+- Level: INFO
+- Minimal output for tests
+
+### Debug
+- Format: Colored
+- Level: DEBUG
+- Maximum verbosity
+
+## Documentation
+
+See [docs/usage.md](docs/usage.md) for complete documentation including:
+- Advanced configuration
+- Custom formatters
+- Best practices
+- Integration examples
+
+## Example
+
+Run the example application:
+
+```bash
+python log2fast_fastapi/example.py
+```
+
+Then visit:
+- http://localhost:8000/ - Root endpoint
+- http://localhost:8000/users/123 - User endpoint
+- http://localhost:8000/docs - API documentation
+
+## Testing
+
+Run the test suite:
+
+```bash
+python log2fast_fastapi/tests/test_logging.py
+```
+
+## Module Structure
+
+```
+log2fast-fastapi/
+├── pyproject.toml       # Package configuration
+├── MANIFEST.in          # Additional files to include
+├── README.md            # This file
+├── LICENSE              # License file
+├── src/
+│   └── log2fast_fastapi/
+│       ├── __init__.py          # Main exports
+│       ├── __version__.py       # Version information
+│       ├── base.py              # Core FastLogger class
+│       ├── settings.py          # Configuration with Pydantic
+│       ├── formatters.py        # Custom log formatters
+│       └── middleware.py        # FastAPI middleware
+├── docs/
+│   ├── usage.md                 # Complete documentation
+│   ├── file_management.md       # File rotation guide (EN)
+│   ├── file_management_es.md    # File rotation guide (ES)
+│   ├── logger_best_practices.md # Best practices
+│   └── publishing.md            # PyPI publishing guide
+├── examples/
+│   ├── example.py               # Basic example
+│   ├── demo_features.py         # Feature demonstrations
+│   └── demo_rotation.py         # Rotation examples
+└── tests/
+    ├── test_logging.py          # Test suite
+    └── test_new_features.py     # Feature tests
+```
+
+## License
+
+Same as parent project.

log2fast_fastapi-0.1.0/README.md

@@ -0,0 +1,232 @@
+# log2fast-fastapi
+
+🚀 Advanced logging module for FastAPI with file rotation, colored output, and environment-based auto-configuration
+
+> [!WARNING]
+> **Internal Use Notice**
+> 
+> This package is designed and maintained by the **Solautyc Team** for internal use. While it is publicly available, it may not work as expected in all environments or use cases outside of our specific infrastructure. We do not provide support or guarantees for external usage, and we are not responsible for any issues that may arise from using this package in other contexts.
+> 
+> Use at your own risk. Contributions and feedback are welcome, but compatibility with external environments is not guaranteed.
+
+## Features
+
+- 🎨 **Multiple Output Formats**: JSON (production), Colored (development), Structured (debugging), Simple (testing)
+- 🌍 **Environment-Based Configuration**: Automatic setup for dev, test, prod, and debug
+- 📦 **Module-Based Loggers**: Each module gets its own logger instance
+- 🔄 **File Rotation**: Automatic log file rotation with configurable size
+- 🔄 **Environment-Specific Logging**: Control which logs appear in which environments (prevent sensitive data leaks)
+- 🚀 **FastAPI Integration**: Middleware for automatic request/response logging with unique request IDs
+- 📊 **Structured Logging**: Add context data to any log message
+- 📊 **Context Injection**: Support for request_id, user_id, and custom context data
+- 🎯 **Zero Configuration**: Works out of the box with sensible defaults
+
+## 📚 Documentation
+
+- **[Usage Guide](docs/usage.md)** - Comprehensive usage guide with examples
+- **[File Management](docs/file_management.md)** - Complete guide on log rotation and storage (English)
+- **[Gestión de Archivos](docs/file_management_es.md)** - Guía completa de rotación y almacenamiento (Español)
+- **[Logger Best Practices](docs/logger_best_practices.md)** - Best practices for creating and naming loggers
+
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install log2fast-fastapi
+```
+
+### From Source
+
+```bash
+# Clone the repository
+git clone https://github.com/AngelDanielSanchezCastillo/log2fast-fastapi.git
+cd log2fast-fastapi
+
+# Install in development mode
+pip install -e .
+
+# Or install with dev dependencies
+pip install -e ".[dev]"
+```
+
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from log2fast_fastapi import get_logger
+
+logger = get_logger(__name__)
+
+logger.info("Application started")
+logger.warning("This is a warning")
+logger.error("An error occurred")
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from log2fast_fastapi import RequestLoggingMiddleware, get_logger
+
+app = FastAPI()
+app.add_middleware(RequestLoggingMiddleware)
+
+logger = get_logger(__name__)
+
+@app.get("/")
+async def root():
+    logger.info("Root endpoint accessed")
+    return {"message": "Hello World"}
+```
+
+### Logging with Context
+
+```python
+from log2fast_fastapi import get_logger
+
+logger = get_logger(__name__)
+
+logger.info(
+    "User logged in",
+    extra_data={
+        "user_id": "12345",
+        "ip_address": "192.168.1.1"
+    }
+)
+```
+
+### Environment-Specific Logging (Prevent Sensitive Data Leaks!)
+
+```python
+# Logs ONLY in development/debug (NOT in production)
+logger.debug(
+    "Sensitive debug info",
+    extra_data={"password_hash": "...", "token": "..."},
+    only_in=["development", "debug"]
+)
+
+# Logs ONLY in production
+logger.info(
+    "Performance metrics",
+    extra_data={"response_time": 120},
+    only_in=["production"]
+)
+```
+
+## Configuration
+
+**Simple: Just set the environment in `.env`**
+
+```bash
+# That's it! Format and level auto-configure
+LOG_ENVIRONMENT=production
+```
+
+Auto-configuration by environment:
+
+| Environment | Auto Level | Auto Format |
+|------------|-----------|-------------|
+| `development` | INFO | colored |
+| `production` | WARNING | json |
+| `testing` | INFO | simple |
+| `debug` | DEBUG | colored |
+
+**Optional: Override defaults**
+
+
+```bash
+# Optional: Override auto-configuration
+LOG_LEVEL=DEBUG
+LOG_FORMAT=json
+LOG_FILE_SETTINGS__ENABLED=true
+```
+
+## Environment Presets
+
+### Development
+- Format: Colored console output
+- Level: INFO
+- Perfect for local development
+
+### Production
+- Format: JSON (structured)
+- Level: WARNING
+- Optimized for log aggregation tools
+
+### Testing
+- Format: Simple
+- Level: INFO
+- Minimal output for tests
+
+### Debug
+- Format: Colored
+- Level: DEBUG
+- Maximum verbosity
+
+## Documentation
+
+See [docs/usage.md](docs/usage.md) for complete documentation including:
+- Advanced configuration
+- Custom formatters
+- Best practices
+- Integration examples
+
+## Example
+
+Run the example application:
+
+```bash
+python log2fast_fastapi/example.py
+```
+
+Then visit:
+- http://localhost:8000/ - Root endpoint
+- http://localhost:8000/users/123 - User endpoint
+- http://localhost:8000/docs - API documentation
+
+## Testing
+
+Run the test suite:
+
+```bash
+python log2fast_fastapi/tests/test_logging.py
+```
+
+## Module Structure
+
+```
+log2fast-fastapi/
+├── pyproject.toml       # Package configuration
+├── MANIFEST.in          # Additional files to include
+├── README.md            # This file
+├── LICENSE              # License file
+├── src/
+│   └── log2fast_fastapi/
+│       ├── __init__.py          # Main exports
+│       ├── __version__.py       # Version information
+│       ├── base.py              # Core FastLogger class
+│       ├── settings.py          # Configuration with Pydantic
+│       ├── formatters.py        # Custom log formatters
+│       └── middleware.py        # FastAPI middleware
+├── docs/
+│   ├── usage.md                 # Complete documentation
+│   ├── file_management.md       # File rotation guide (EN)
+│   ├── file_management_es.md    # File rotation guide (ES)
+│   ├── logger_best_practices.md # Best practices
+│   └── publishing.md            # PyPI publishing guide
+├── examples/
+│   ├── example.py               # Basic example
+│   ├── demo_features.py         # Feature demonstrations
+│   └── demo_rotation.py         # Rotation examples
+└── tests/
+    ├── test_logging.py          # Test suite
+    └── test_new_features.py     # Feature tests
+```
+
+## License
+
+Same as parent project.

log2fast_fastapi-0.1.0/docs/env.example

@@ -0,0 +1,149 @@
+# ============================================
+# LOG2FAST_FASTAPI - Configuración de Logging
+# ============================================
+
+# ===== CONFIGURACIÓN BÁSICA (REQUERIDA) =====
+
+# Ambiente de ejecución (determina auto-configuración)
+# Opciones: development, production, testing, debug
+LOG_ENVIRONMENT=development
+
+
+# ===== CONFIGURACIÓN OPCIONAL (OVERRIDES) =====
+
+# Nivel de log (opcional - se auto-configura según ambiente)
+# Opciones: DEBUG, INFO, WARNING, ERROR, CRITICAL
+# LOG_LEVEL=INFO
+
+# Formato de log (opcional - se auto-configura según ambiente)
+# Opciones: json, colored, structured, simple
+# LOG_FORMAT=colored
+
+
+# ===== CONFIGURACIÓN DE CONSOLA =====
+
+# Habilitar logging en consola
+LOG_CONSOLE_ENABLED=true
+
+
+# ===== CONFIGURACIÓN DE ARCHIVOS =====
+
+# Habilitar logging en archivos
+LOG_FILE_SETTINGS__ENABLED=true
+
+# Directorio donde guardar los logs (relativo al proyecto o absoluto)
+# Default: logs/ (en la raíz del proyecto)
+LOG_FILE_SETTINGS__DIRECTORY=logs
+
+# Estrategia de rotación de archivos
+# Opciones: time (por tiempo), size (por tamaño)
+# Default: time (diario a medianoche, 31 días de backups)
+LOG_FILE_SETTINGS__ROTATION_STRATEGY=time
+
+
+# ===== ROTACIÓN POR TIEMPO (cuando ROTATION_STRATEGY=time) =====
+
+# Cuándo rotar los archivos
+# Opciones:
+#   - midnight: A medianoche (default)
+#   - H: Cada hora
+#   - D: Cada día
+#   - W0-W6: Cada semana (W0=Lunes, W6=Domingo)
+LOG_FILE_SETTINGS__WHEN=midnight
+
+# Intervalo de rotación (usado con 'when')
+# Ejemplos:
+#   - 1 con when=midnight: Diario
+#   - 2 con when=midnight: Cada 2 días
+#   - 1 con when=H: Cada hora
+LOG_FILE_SETTINGS__INTERVAL=1
+
+# Número de archivos de backup a mantener
+# Default: 31 (31 días de logs si es diario)
+LOG_FILE_SETTINGS__BACKUP_COUNT=31
+
+
+# ===== ROTACIÓN POR TAMAÑO (cuando ROTATION_STRATEGY=size) =====
+
+# Tamaño máximo por archivo en bytes
+# Ejemplos:
+#   - 10485760 = 10MB (default)
+#   - 52428800 = 50MB
+#   - 104857600 = 100MB
+# LOG_FILE_SETTINGS__MAX_BYTES=10485760
+
+# Número de archivos de backup a mantener (para rotación por tamaño)
+# LOG_FILE_SETTINGS__BACKUP_COUNT=5
+
+
+# ===== CONFIGURACIÓN DE NOMBRES DE ARCHIVO =====
+
+# Patrón para nombres de archivos
+# Variables disponibles: {module}, {environment}, {logger}
+# Default: {module}_{environment}.log
+# Ejemplos:
+#   - app_{environment}.log
+#   - {logger}_{environment}.log (útil con per_module_files)
+LOG_FILE_SETTINGS__FILENAME_PATTERN={module}_{environment}.log
+
+# Crear archivos separados por módulo
+# Si es true, cada logger (módulo) tendrá su propio archivo
+# Ejemplo: oauth2fast_fastapi_development.log, app_api_development.log
+LOG_FILE_SETTINGS__PER_MODULE_FILES=false
+
+
+# ===== CONFIGURACIÓN DE REQUESTS (FastAPI Middleware) =====
+
+# Habilitar logging de requests HTTP
+LOG_LOG_REQUESTS=true
+
+# Incluir body del request en logs (cuidado con PII)
+LOG_LOG_REQUEST_BODY=false
+
+# Incluir body del response en logs (cuidado con PII)
+LOG_LOG_RESPONSE_BODY=false
+
+
+# ===== CONFIGURACIÓN DE MÓDULO =====
+
+# Nombre del módulo principal (usado en nombres de archivo)
+# Default: app
+LOG_MODULE_NAME=iso_solautyc
+
+
+# ============================================
+# EJEMPLOS DE CONFIGURACIÓN POR AMBIENTE
+# ============================================
+
+# --- DESARROLLO LOCAL ---
+# LOG_ENVIRONMENT=development
+# LOG_FILE_SETTINGS__ROTATION_STRATEGY=time
+# LOG_FILE_SETTINGS__WHEN=midnight
+# LOG_FILE_SETTINGS__BACKUP_COUNT=7
+# Resultado: Logs diarios, mantiene 7 días
+
+# --- PRODUCCIÓN ---
+# LOG_ENVIRONMENT=production
+# LOG_FILE_SETTINGS__ROTATION_STRATEGY=time
+# LOG_FILE_SETTINGS__WHEN=midnight
+# LOG_FILE_SETTINGS__BACKUP_COUNT=31
+# Resultado: Logs diarios en JSON, mantiene 31 días
+
+# --- DEBUGGING ---
+# LOG_ENVIRONMENT=debug
+# LOG_FILE_SETTINGS__ROTATION_STRATEGY=size
+# LOG_FILE_SETTINGS__MAX_BYTES=52428800
+# LOG_FILE_SETTINGS__BACKUP_COUNT=3
+# Resultado: Logs cuando llega a 50MB, mantiene 3 archivos
+
+# --- TESTING ---
+# LOG_ENVIRONMENT=testing
+# LOG_FILE_SETTINGS__ENABLED=false
+# Resultado: Solo logs en consola, sin archivos
+
+# --- LOGS POR MÓDULO ---
+# LOG_FILE_SETTINGS__PER_MODULE_FILES=true
+# Resultado: Cada módulo tiene su archivo
+#   - oauth2fast_fastapi_routers_auth_development.log
+#   - app_services_user_development.log
+#   - etc.