json-logify 0.1.0__tar.gz

json_logify-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kulbarakov Bakdoolot
+
+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.

json_logify-0.1.0/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: json-logify
+Version: 0.1.0
+Summary: Universal structured logging with exact JSON schema for Python frameworks
+Author-email: Bakdoolot Kulbarakov <kulbarakovbh@gmail.com>
+Maintainer-email: Bakdoolot Kulbarakov <kulbarakovbh@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Kulbarakov Bakdoolot
+        
+        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/yourusername/json-logify
+Project-URL: Documentation, https://json-logify.readthedocs.io/
+Project-URL: Repository, https://github.com/yourusername/json-logify
+Project-URL: Issues, https://github.com/yourusername/json-logify/issues
+Project-URL: Changelog, https://github.com/yourusername/json-logify/blob/main/CHANGELOG.md
+Keywords: logging,structured,json,django,fastapi,flask,universal,schema,orjson,structlog
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Classifier: Framework :: Django
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Flask
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: structlog>=23.0.0
+Requires-Dist: orjson>=3.8.0
+Provides-Extra: django
+Requires-Dist: django>=5.2.6; extra == "django"
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.116.1; extra == "fastapi"
+Requires-Dist: uvicorn>=0.35.0; extra == "fastapi"
+Provides-Extra: flask
+Requires-Dist: flask>=3.1.2; extra == "flask"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4.2; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: bandit>=1.7.5; extra == "dev"
+Provides-Extra: all
+Requires-Dist: json-logify[django,fastapi,flask]; extra == "all"
+Dynamic: license-file
+
+# json-logify
+
+Universal structured logging with exact JSON schema for Python frameworks.
+
+[![PyPI version](https://badge.fury.io/py/json-logify.svg)](https://badge.fury.io/py/json-logify)
+[![Python Support](https://img.shields.io/pypi/pyversions/json-logify.svg)](https://pypi.org/project/json-logify/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- <� **Exact JSON Schema**: Consistent log format across all frameworks
+- � **High Performance**: Built with structlog and orjson for maximum speed
+- < **Universal**: Works with Django, FastAPI, Flask, and standalone Python
+- =' **Easy Setup**: One-line configuration for most use cases
+- =� **Rich Context**: Request IDs, user tracking, and custom payload support
+- =
+ **Modern Python**: Full type hints and async support
+
+## Quick Start
+
+### Installation
+
+```bash
+# Basic installation
+pip install json-logify
+
+# For specific frameworks
+pip install json-logify[django]
+pip install json-logify[fastapi]
+pip install json-logify[flask]
+
+# Everything
+pip install json-logify[all]
+```
+
+### Basic Usage
+
+```python
+from logify import info, error
+
+# Simple logging
+info("User logged in", user_id="12345", action="login")
+
+# Error logging with exception
+try:
+    raise ValueError("Something went wrong")
+except Exception as e:
+    error("Operation failed", error=e, operation="data_processing")
+```
+
+Output:
+```json
+{
+  "timestamp": "2025-01-15T10:30:00.123Z",
+  "message": "User logged in",
+  "level": "INFO",
+  "payload": {
+    "user_id": "12345",
+    "action": "login"
+  }
+}
+```
+
+### Django Integration
+
+```python
+# settings.py
+from logify.django import get_logging_config
+
+LOGGING = get_logging_config(
+    service_name="myapp",
+    json_logs=True
+)
+
+# Add middleware (optional for request tracking)
+MIDDLEWARE = [
+    'logify.django.LogifyMiddleware',
+    # ... other middleware
+]
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from logify.fastapi import LogifyMiddleware
+
+app = FastAPI()
+app.add_middleware(LogifyMiddleware, service_name="myapi")
+
+@app.get("/")
+async def root():
+    from logify import info
+    info("API endpoint called", endpoint="/")
+    return {"message": "Hello World"}
+```
+
+### Flask Integration
+
+```python
+from flask import Flask
+from logify.flask import init_logify
+
+app = Flask(__name__)
+init_logify(app, service_name="myapp")
+
+@app.route("/")
+def hello():
+    from logify import info
+    info("Flask endpoint called", endpoint="/")
+    return "Hello, World!"
+```
+
+## Advanced Usage
+
+### Context Management
+
+```python
+from logify import bind, set_request_context, clear_request_context
+
+# Bind context to a logger
+logger = bind(service="auth", module="login")
+logger.info("Processing login", user_id="123")
+
+# Set request-level context (useful in middleware)
+set_request_context(request_id="req-456", user_id="123")
+info("User action", action="view_profile")  # Includes request context
+clear_request_context()
+```
+
+### Performance Tracking
+
+```python
+from logify import track_performance
+
+@track_performance
+def expensive_operation():
+    # Your code here
+    return "result"
+
+# Automatically logs function start, completion, and duration
+```
+
+### Custom Configuration
+
+```python
+from logify import configure_logging
+
+# Configure with custom settings
+configure_logging(
+    service_name="myapp",
+    level="DEBUG"
+)
+```
+
+## Log Schema
+
+All logs follow this exact JSON schema:
+
+```json
+{
+  "timestamp": "2025-01-15T10:30:00.123Z",
+  "message": "Log message here",
+  "level": "INFO",
+  "error": "Error description (optional)",
+  "payload": {
+    "service": "myapp",
+    "request_id": "req-123",
+    "custom_field": "custom_value"
+  }
+}
+```
+
+The `error` field is optional and will only appear when logging errors or exceptions.
+
+## Requirements
+
+- Python 3.8+
+- structlog >= 23.0.0
+- orjson >= 3.8.0
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

json_logify-0.1.0/README.md

@@ -0,0 +1,187 @@
+# json-logify
+
+Universal structured logging with exact JSON schema for Python frameworks.
+
+[![PyPI version](https://badge.fury.io/py/json-logify.svg)](https://badge.fury.io/py/json-logify)
+[![Python Support](https://img.shields.io/pypi/pyversions/json-logify.svg)](https://pypi.org/project/json-logify/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+- <� **Exact JSON Schema**: Consistent log format across all frameworks
+- � **High Performance**: Built with structlog and orjson for maximum speed
+- < **Universal**: Works with Django, FastAPI, Flask, and standalone Python
+- =' **Easy Setup**: One-line configuration for most use cases
+- =� **Rich Context**: Request IDs, user tracking, and custom payload support
+- =
 **Modern Python**: Full type hints and async support
+
+## Quick Start
+
+### Installation
+
+```bash
+# Basic installation
+pip install json-logify
+
+# For specific frameworks
+pip install json-logify[django]
+pip install json-logify[fastapi]
+pip install json-logify[flask]
+
+# Everything
+pip install json-logify[all]
+```
+
+### Basic Usage
+
+```python
+from logify import info, error
+
+# Simple logging
+info("User logged in", user_id="12345", action="login")
+
+# Error logging with exception
+try:
+    raise ValueError("Something went wrong")
+except Exception as e:
+    error("Operation failed", error=e, operation="data_processing")
+```
+
+Output:
+```json
+{
+  "timestamp": "2025-01-15T10:30:00.123Z",
+  "message": "User logged in",
+  "level": "INFO",
+  "payload": {
+    "user_id": "12345",
+    "action": "login"
+  }
+}
+```
+
+### Django Integration
+
+```python
+# settings.py
+from logify.django import get_logging_config
+
+LOGGING = get_logging_config(
+    service_name="myapp",
+    json_logs=True
+)
+
+# Add middleware (optional for request tracking)
+MIDDLEWARE = [
+    'logify.django.LogifyMiddleware',
+    # ... other middleware
+]
+```
+
+### FastAPI Integration
+
+```python
+from fastapi import FastAPI
+from logify.fastapi import LogifyMiddleware
+
+app = FastAPI()
+app.add_middleware(LogifyMiddleware, service_name="myapi")
+
+@app.get("/")
+async def root():
+    from logify import info
+    info("API endpoint called", endpoint="/")
+    return {"message": "Hello World"}
+```
+
+### Flask Integration
+
+```python
+from flask import Flask
+from logify.flask import init_logify
+
+app = Flask(__name__)
+init_logify(app, service_name="myapp")
+
+@app.route("/")
+def hello():
+    from logify import info
+    info("Flask endpoint called", endpoint="/")
+    return "Hello, World!"
+```
+
+## Advanced Usage
+
+### Context Management
+
+```python
+from logify import bind, set_request_context, clear_request_context
+
+# Bind context to a logger
+logger = bind(service="auth", module="login")
+logger.info("Processing login", user_id="123")
+
+# Set request-level context (useful in middleware)
+set_request_context(request_id="req-456", user_id="123")
+info("User action", action="view_profile")  # Includes request context
+clear_request_context()
+```
+
+### Performance Tracking
+
+```python
+from logify import track_performance
+
+@track_performance
+def expensive_operation():
+    # Your code here
+    return "result"
+
+# Automatically logs function start, completion, and duration
+```
+
+### Custom Configuration
+
+```python
+from logify import configure_logging
+
+# Configure with custom settings
+configure_logging(
+    service_name="myapp",
+    level="DEBUG"
+)
+```
+
+## Log Schema
+
+All logs follow this exact JSON schema:
+
+```json
+{
+  "timestamp": "2025-01-15T10:30:00.123Z",
+  "message": "Log message here",
+  "level": "INFO",
+  "error": "Error description (optional)",
+  "payload": {
+    "service": "myapp",
+    "request_id": "req-123",
+    "custom_field": "custom_value"
+  }
+}
+```
+
+The `error` field is optional and will only appear when logging errors or exceptions.
+
+## Requirements
+
+- Python 3.8+
+- structlog >= 23.0.0
+- orjson >= 3.8.0
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.