logeverything 0.1.3__tar.gz

logeverything-0.1.3/LICENSE

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

logeverything-0.1.3/PKG-INFO

@@ -0,0 +1,484 @@
+Metadata-Version: 2.4
+Name: logeverything
+Version: 0.1.3
+Summary: A comprehensive logging library for Python applications with minimal code changes
+Home-page: https://github.com/RamishSiddiqui/logeverything
+Author: Muhammad Ramish Siddiqui
+Author-email: Muhammad Ramish Siddiqui <ramishsiddique46@gmail.com>
+License: MIT
+Project-URL: Documentation, https://logeverything.readthedocs.io/
+Project-URL: Source, https://github.com/RamishSiddiqui/logeverything
+Project-URL: Tracker, https://github.com/RamishSiddiqui/logeverything/issues
+Keywords: logging,log,debug,tracing,performance,monitoring,visualization,hierarchical,decorators
+Platform: unix
+Platform: linux
+Platform: osx
+Platform: cygwin
+Platform: win32
+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.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
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorama>=0.4.4
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: ruff>=0.1.6; extra == "dev"
+Requires-Dist: mypy>=0.971; extra == "dev"
+Requires-Dist: bandit>=1.7.0; extra == "dev"
+Requires-Dist: sphinx>=5.0.0; extra == "dev"
+Requires-Dist: furo>=2023.5.20; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints>=1.18.0; extra == "dev"
+Requires-Dist: myst-parser>=2.0.0; extra == "dev"
+Requires-Dist: build>=0.8.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: wheel>=0.38.0; extra == "dev"
+Requires-Dist: pre-commit>=3.3.2; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.0.0; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0.0; extra == "docs"
+Requires-Dist: furo>=2023.5.20; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=1.18.0; extra == "docs"
+Requires-Dist: myst-parser>=2.0.0; extra == "docs"
+Provides-Extra: full
+Requires-Dist: rich>=10.0.0; extra == "full"
+Requires-Dist: orjson>=3.5.0; extra == "full"
+Requires-Dist: fastapi>=0.68.0; extra == "full"
+Requires-Dist: requests>=2.25.0; extra == "full"
+Requires-Dist: sqlalchemy>=1.4.0; extra == "full"
+Requires-Dist: pydantic>=1.8.0; extra == "full"
+Requires-Dist: prometheus-client>=0.12.0; extra == "full"
+Requires-Dist: elasticsearch>=7.0.0; extra == "full"
+Requires-Dist: mlflow>=1.0.0; extra == "full"
+Requires-Dist: pillow>=9.0.0; extra == "full"
+Provides-Extra: web
+Requires-Dist: fastapi>=0.68.0; extra == "web"
+Requires-Dist: starlette>=0.14.0; extra == "web"
+Requires-Dist: flask>=2.0.0; extra == "web"
+Requires-Dist: django>=3.2.0; extra == "web"
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.68.0; extra == "fastapi"
+Requires-Dist: starlette>=0.14.0; extra == "fastapi"
+Provides-Extra: flask
+Requires-Dist: flask>=2.0.0; extra == "flask"
+Provides-Extra: django
+Requires-Dist: django>=3.2.0; extra == "django"
+Provides-Extra: visual
+Requires-Dist: rich>=10.0.0; extra == "visual"
+Requires-Dist: pillow>=9.0.0; extra == "visual"
+Provides-Extra: json
+Requires-Dist: orjson>=3.5.0; extra == "json"
+Provides-Extra: db
+Requires-Dist: sqlalchemy>=1.4.0; extra == "db"
+Provides-Extra: metrics
+Requires-Dist: prometheus-client>=0.12.0; extra == "metrics"
+Provides-Extra: ml
+Requires-Dist: mlflow>=1.0.0; extra == "ml"
+Requires-Dist: numpy>=1.20.0; extra == "ml"
+Requires-Dist: pandas>=1.3.0; extra == "ml"
+Provides-Extra: cloud
+Requires-Dist: boto3>=1.17.0; extra == "cloud"
+Requires-Dist: google-cloud-logging>=2.0.0; extra == "cloud"
+Requires-Dist: azure-monitor-opentelemetry>=1.0.0; extra == "cloud"
+Dynamic: license-file
+
+<p align="center">
+  <h1 align="center">LogEverything</h1>
+  <p align="center">
+    <strong>High-performance Python logging with zero configuration.</strong>
+  </p>
+  <p align="center">
+    <a href="https://pypi.org/project/logeverything/"><img src="https://img.shields.io/pypi/v/logeverything.svg" alt="PyPI"></a>
+    <a href="https://pypi.org/project/logeverything/"><img src="https://img.shields.io/pypi/pyversions/logeverything.svg" alt="Python"></a>
+    <a href="https://github.com/RamishSiddiqui/logeverything/actions"><img src="https://img.shields.io/github/actions/workflow/status/RamishSiddiqui/logeverything/python-ci.yml?branch=main" alt="Build"></a>
+    <a href="https://codecov.io/gh/RamishSiddiqui/logeverything"><img src="https://codecov.io/gh/RamishSiddiqui/logeverything/branch/main/graph/badge.svg" alt="Coverage"></a>
+    <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a>
+    <a href="https://pypi.org/project/logeverything/"><img src="https://img.shields.io/pypi/dm/logeverything.svg?label=downloads" alt="Downloads"></a>
+    <a href="https://github.com/RamishSiddiqui/logeverything"><img src="https://img.shields.io/github/repo-size/RamishSiddiqui/logeverything?label=code%20size" alt="Code Size"></a>
+    <a href="https://github.com/RamishSiddiqui/logeverything/commits/main"><img src="https://img.shields.io/github/last-commit/RamishSiddiqui/logeverything" alt="Last Commit"></a>
+    <a href="https://github.com/RamishSiddiqui/logeverything/issues"><img src="https://img.shields.io/github/issues/RamishSiddiqui/logeverything" alt="Issues"></a>
+    <a href="https://github.com/RamishSiddiqui/logeverything/stargazers"><img src="https://img.shields.io/github/stars/RamishSiddiqui/logeverything?style=social" alt="Stars"></a>
+  </p>
+</p>
+
+Add decorators to your functions for automatic, comprehensive logging. LogEverything captures inputs, outputs, execution times, and call hierarchy — with thread safety, async isolation, and beautiful formatting out of the box.
+
+<table>
+<tr>
+<td align="center"><strong><h3>10k ops/sec</h3></strong><sub>Core Logging Throughput</sub></td>
+<td align="center"><strong><h3>&lt;0.5ms</h3></strong><sub>Decorator Overhead</sub></td>
+<td align="center"><strong><h3>7.9k ops/sec</h3></strong><sub>Print Capture</sub></td>
+<td align="center"><strong><h3>395 tests</h3></strong><sub>65% coverage</sub></td>
+</tr>
+</table>
+
+---
+
+## Why LogEverything?
+
+Most Python logging libraries make you choose: simple but limited (`logging`), fast but
+opinionated (`loguru`), or structured but complex (`structlog`). LogEverything combines
+decorator-based function tracing, native async support, structured JSON output, file
+rotation, and a companion monitoring dashboard — all with zero-config defaults and
+production-grade performance.
+
+| Feature | `logging` | `loguru` | `structlog` | **LogEverything** |
+|---|:---:|:---:|:---:|:---:|
+| Zero-config decorators | | | | :white_check_mark: |
+| Hierarchical call tracing | | | | :white_check_mark: |
+| Async-native with task isolation | | | :white_check_mark: | :white_check_mark: |
+| Structured JSON output | | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| File rotation + gzip compression | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
+| Print capture (stdout redirect) | | | | :white_check_mark: |
+| Monitoring dashboard | | | | :white_check_mark: |
+| Configuration profiles | | | | :white_check_mark: |
+
+---
+
+## Install
+
+```bash
+pip install logeverything
+```
+
+## Quick Start
+
+### Logger
+
+```python
+from logeverything import Logger
+
+log = Logger("my_app")
+log.info("Application started")
+log.warning("Disk usage high")
+log.error("Connection failed")
+```
+
+### Decorators
+
+```python
+from logeverything import Logger
+from logeverything.decorators import log
+
+app_log = Logger("my_app")
+
+@log                          # auto-detect context
+def process(items):
+    return sum(items)
+
+@log(using="my_app")          # target a specific logger
+def validate(data):
+    return len(data) > 0
+
+process([1, 2, 3])
+validate("hello")
+```
+
+**Output:**
+```
+-> process(items=[1, 2, 3]) [app.py:7]
+<- process (0.03ms) -> 6
+-> validate(data='hello') [app.py:11]
+<- validate (0.01ms) -> True
+```
+
+### Hierarchical Call Tracing
+
+```python
+from logeverything.decorators import log_function
+
+@log_function
+def main():
+    step1()
+
+@log_function
+def step1():
+    step2()
+
+@log_function
+def step2():
+    print("Processing...")
+
+main()
+```
+
+```
+-> main() [app.py:3]
+|   -> step1() [app.py:7]
+|   |   -> step2() [app.py:11]
+|   |   |   Processing...
+|   |   <- step2 (0.12ms)
+|   <- step1 (0.45ms)
+<- main (1.02ms)
+```
+
+### Async
+
+```python
+from logeverything import AsyncLogger
+import asyncio
+
+log = AsyncLogger("worker")
+
+async def fetch(url):
+    log.info(f"GET {url}")
+    await asyncio.sleep(0.1)
+    log.info("Done")
+
+asyncio.run(fetch("https://api.example.com"))
+```
+
+### Profiles
+
+```python
+from logeverything import Logger
+
+log = Logger("my_app")
+log.configure(profile="production")    # minimal overhead, structured output
+log.configure(profile="development")   # rich colors and visual hierarchy
+log.configure(profile="api")           # optimized for web services
+```
+
+### CLI Tool
+
+```bash
+$ logeverything version
+logeverything 0.1.0
+Python 3.11.9
+Platform: Windows-10-10.0.26100-SP0
+
+$ logeverything doctor
+logeverything doctor
+  [✓] Python 3.11.9
+  [✓] psutil 5.9.5
+  [✗] celery (not installed)
+  [✓] py.typed marker present
+  [✗] Dashboard at localhost:8999 (not reachable)
+
+$ logeverything init
+Select environment type:
+  1) web   2) script   3) notebook
+→ Creates logging_config.py with sensible defaults
+```
+
+Also available as `python -m logeverything`.
+
+### File Rotation
+
+```python
+from logeverything.handlers import TimedRotatingFileHandler
+
+handler = TimedRotatingFileHandler(
+    "logs/app.log",
+    when="midnight",       # rotate daily at midnight
+    retention_days=30,     # keep 30 days of logs
+    compress=True,         # gzip old files
+)
+```
+
+Size-based rotation with compression is also supported via `FileHandler`:
+
+```python
+from logeverything.handlers import FileHandler
+
+handler = FileHandler(
+    "logs/app.log",
+    max_size=10_485_760,   # 10 MB
+    backup_count=5,
+    compress=True,         # gzip rotated files
+)
+```
+
+For dashboard-compatible structured output, attach `JSONLineFormatter` to any handler:
+
+```python
+from logeverything.handlers import FileHandler, JSONLineFormatter
+
+handler = FileHandler("logs/app.jsonl", max_size=10_485_760, backup_count=5)
+handler.setFormatter(JSONLineFormatter(source="my_service"))
+```
+
+---
+
+## Architecture
+
+```mermaid
+graph TD
+    A["Your Code"] -->|"@log decorator"| B["Decorators"]
+    B --> C["Logger / AsyncLogger"]
+    C --> D["ConsoleHandler"]
+    C --> E["FileHandler + Rotation"]
+    C --> F["JSONHandler"]
+    C --> G["HTTP / TCP / UDP Transport"]
+    G --> H["Dashboard"]
+    E -->|"JSONL files"| H
+```
+
+---
+
+## Features
+
+<table>
+<tr>
+<td width="50%" valign="top">
+
+**Core**
+- Unified `@log` decorator — functions, classes, async
+- Smart logger selection with `using` parameter
+- Auto-discovery and registration of logger instances
+- Structured binding: `log.bind(user_id=123)`
+- Context managers: `log.verbose()`, `log.quiet()`
+
+</td>
+<td width="50%" valign="top">
+
+**Performance & Safety**
+- 10k ops/sec core logging, 7.9k ops/sec print capture
+- Async-native with 454 ops/sec task-isolated logging
+- Zero overhead when logging is disabled
+- Automatic thread-safe context isolation
+- 395 tests, 65% coverage
+- Cross-platform (Windows, macOS, Linux)
+
+</td>
+</tr>
+<tr>
+<td width="50%" valign="top">
+
+**Output**
+- Console, file, JSON, and JSONL (`JSONLineFormatter`) handlers
+- Time-based and size-based file rotation with gzip
+- Color themes with Unicode symbols
+- Hierarchical indentation and aligned columns
+- Automatic UTF-8 encoding on Windows
+- 7.9k ops/sec `capture_print()` for stdout
+
+</td>
+<td width="50%" valign="top">
+
+**Integrations**
+- ASGI/WSGI middleware (FastAPI, Flask, Django)
+- Celery task logging with correlation propagation
+- Correlation IDs across requests and threads
+- Log transports: HTTP, TCP, UDP
+- CLI tool (`logeverything doctor`, `init`)
+- Monitoring API with WebSocket streaming
+
+</td>
+</tr>
+</table>
+
+---
+
+## Monitoring Dashboard
+
+A companion web dashboard for exploring logs, operations, and system metrics in real time. The dashboard is **not included** in the base `pip install logeverything` — install it separately using one of the methods below.
+
+![Dashboard](docs/source/_static/screenshots/dashboard_overview.png)
+
+### Install from PyPI
+
+```bash
+pip install logeverything-dashboard
+
+# Start the dashboard
+logeverything-dashboard                     # http://localhost:3001
+
+# Point it at your log directory
+logeverything-dashboard --data-dir ./logs
+
+# Or connect to a remote LogEverything API
+logeverything-dashboard --api-url http://localhost:8080/api/v1
+```
+
+### Install from Source
+
+If you cloned the LogEverything repo, the dashboard is included in the `logeverything-dashboard/` directory:
+
+```bash
+cd logeverything-dashboard
+pip install -r requirements.txt
+
+# (Optional) Copy and edit the config file
+cp config/settings.example.yaml config/settings.yaml
+
+# Start the dashboard
+python run_dashboard.py          # http://localhost:3001
+```
+
+<table>
+<tr>
+<td width="50%" valign="top">
+
+**Pages**
+- **Overview** — summary cards, CPU/memory trends, log distribution, operation analytics
+- **Logs** — filterable table with multi-select level pills, pagination, flat + tree view
+- **Operations** — analytics with failure rates and duration tracking
+- **System** — detailed process/resource metrics, session info
+
+</td>
+<td width="50%" valign="top">
+
+**Capabilities**
+- Hierarchical tree view with expand/collapse and duration badges
+- Time-range filtering (1h / 6h / 24h / 7d)
+- Full-text log search and correlation ID tracing
+- Dark and light themes
+- Keyboard shortcuts, auto-refresh, JSON export
+- Real-time updates via WebSocket
+
+</td>
+</tr>
+</table>
+
+[Dashboard Guide](docs/source/user-guide/dashboard.rst) — full documentation with screenshots, API endpoints, and customisation.
+
+---
+
+## Documentation
+
+| | |
+|---|---|
+| [Installation](https://logeverything.readthedocs.io/en/latest/installation.html) | Setup and optional extras |
+| [Quick Start](https://logeverything.readthedocs.io/en/latest/quickstart.html) | First steps with LogEverything |
+| [User Guide](https://logeverything.readthedocs.io/en/latest/user-guide/logger-classes.html) | Logger classes, decorators, profiles, handlers, async, integrations |
+| [Dashboard](https://logeverything.readthedocs.io/en/latest/user-guide/dashboard.html) | Monitoring dashboard setup and usage |
+| [API Reference](https://logeverything.readthedocs.io/en/latest/api/core.html) | Complete module and class reference |
+| [Advanced](https://logeverything.readthedocs.io/en/latest/advanced/performance.html) | Performance tuning and production deployment |
+
+---
+
+## Contributing
+
+Contributions welcome. See the [Contributing Guide](https://logeverything.readthedocs.io/en/latest/contributing.html).
+
+```bash
+pip install -e ".[dev]"
+logeverything doctor   # check environment and optional deps
+make test              # run tests with coverage
+make lint              # flake8, black, isort, mypy, bandit
+make format            # auto-format
+```
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+<p align="center"><sub>Built for developers who believe every function call tells a story.</sub></p>
+ 
+
+