python-log-viewer 0.1.0__tar.gz

python_log_viewer-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+*.egg
+.eggs/
+*.whl
+.venv/
+venv/
+.tox/
+.mypy_cache/
+.pytest_cache/
+.venv/
+venv/
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local

python_log_viewer-0.1.0/LICENSE

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

python_log_viewer-0.1.0/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: python-log-viewer
+Version: 0.1.0
+Summary: A beautiful, real-time log viewer with a web UI. Works with Django, Flask, and FastAPI.
+Project-URL: Homepage, https://github.com/imsujan276/python-log-viewer
+Project-URL: Repository, https://github.com/imsujan276/python-log-viewer
+Project-URL: Issues, https://github.com/imsujan276/python-log-viewer/issues
+Author-email: Sujan Gainju <sujangainju01@gmail.com>
+License: MIT
+Keywords: django,fastapi,flask,log,logging,monitoring,viewer,web-ui
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Flask
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.9
+Provides-Extra: all
+Requires-Dist: django>=3.2; extra == 'all'
+Requires-Dist: fastapi>=0.68; extra == 'all'
+Requires-Dist: flask>=2.0; extra == 'all'
+Requires-Dist: uvicorn>=0.15; extra == 'all'
+Provides-Extra: django
+Requires-Dist: django>=3.2; extra == 'django'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.68; extra == 'fastapi'
+Requires-Dist: uvicorn>=0.15; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask>=2.0; extra == 'flask'
+Description-Content-Type: text/markdown
+
+# python-log-viewer
+
+A beautiful, real-time log viewer with a dark-themed web UI. Browse, search, filter, clear, and delete log files — all from your browser.
+
+Integrates seamlessly with **Django**, **Flask**, and **FastAPI**.
+
+![Log Viewer Preview](screenshots/preview.png)
+
+---
+
+## Features
+
+- 📁 **File browser** — sidebar with folder tree, file sizes
+- 🔍 **Search & filter** — full-text search, log-level filtering (DEBUG / INFO / WARNING / ERROR)
+- 🎨 **Colour-coded** — log levels highlighted with subtle background colours
+- 🔄 **Auto-refresh** — configurable live-tail (5s, 10s, 30s, 1m, or manual)
+- 📜 **Line limits** — last 500 / 1000 / 2500 / 5000 / all entries
+- 🗑️ **File actions** — clear (truncate) or delete log files with confirmation modals
+- 🔒 **Basic Auth** — optional HTTP Basic Authentication
+- 📱 **Responsive** — works on mobile with a slide-out sidebar
+---
+
+## Installation
+
+```bash
+pip install python-log-viewer
+```
+
+### Framework extras
+
+```bash
+pip install python-log-viewer[django]    # Django integration
+pip install python-log-viewer[flask]     # Flask integration
+pip install python-log-viewer[fastapi]   # FastAPI integration
+pip install python-log-viewer[all]       # All frameworks
+```
+
+---
+
+## Django Integration
+
+### 1. Install
+
+```bash
+pip install python-log-viewer[django]
+```
+
+### 2. Add to `INSTALLED_APPS`
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "python_log_viewer.contrib.django",
+]
+```
+
+### 3. Include URLs
+
+```python
+# urls.py
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path("logs/", include("python_log_viewer.contrib.django.urls")),
+]
+```
+
+### 4. Configure (optional)
+
+Add any of these to your `settings.py`:
+
+```python
+# Path to your log directory (default: BASE_DIR / "logs")
+LOG_VIEWER_DIR = BASE_DIR / "logs"
+
+# UI defaults
+LOG_VIEWER_AUTO_REFRESH  = True    # enable auto-refresh
+LOG_VIEWER_REFRESH_TIMER = 5000    # refresh interval in ms
+LOG_VIEWER_AUTO_SCROLL   = True    # auto-scroll to bottom
+LOG_VIEWER_COLORIZE      = True    # colour-coded log levels
+
+# Authentication (optional — leave unset to disable)
+LOG_VIEWER_USERNAME = "admin"
+LOG_VIEWER_PASSWORD = "secret"
+
+# Allow logged-in Django superusers to bypass Basic Auth (default: True)
+LOG_VIEWER_SUPERUSER_ACCESS = True
+```
+
+Then visit `http://localhost:8000/logs/` in your browser.
+
+---
+
+## Flask Integration
+
+### 1. Install
+
+```bash
+pip install python-log-viewer[flask]
+```
+
+### 2. Register the blueprint
+
+```python
+from flask import Flask
+from python_log_viewer.contrib.flask import create_log_viewer_blueprint
+
+app = Flask(__name__)
+
+app.register_blueprint(
+    create_log_viewer_blueprint(
+        log_dir="./logs",
+        url_prefix="/logs",
+        username="admin",      # optional
+        password="secret",     # optional
+    )
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+Then visit `http://localhost:5000/logs/` in your browser.
+
+**Blueprint parameters:**
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `log_dir` | `"./logs"` | Path to log directory |
+| `url_prefix` | `"/logs"` | URL prefix |
+| `username` | `None` | Basic-Auth username |
+| `password` | `None` | Basic-Auth password |
+| `auto_refresh` | `True` | Enable auto-refresh |
+| `refresh_timer` | `5000` | Refresh interval (ms) |
+| `auto_scroll` | `True` | Auto-scroll to bottom |
+| `colorize` | `True` | Colour-coded levels |
+
+---
+
+## FastAPI Integration
+
+### 1. Install
+
+```bash
+pip install python-log-viewer[fastapi]
+```
+
+### 2. Include the router
+
+```python
+from fastapi import FastAPI
+from python_log_viewer.contrib.fastapi import create_log_viewer_router
+
+app = FastAPI()
+
+app.include_router(
+    create_log_viewer_router(
+        log_dir="./logs",
+        prefix="/logs",
+        username="admin",      # optional
+        password="secret",     # optional
+    )
+)
+```
+
+Then visit `http://localhost:8000/logs/` in your browser.
+
+**Router parameters:**
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `log_dir` | `"./logs"` | Path to log directory |
+| `prefix` | `"/logs"` | URL prefix |
+| `username` | `None` | Basic-Auth username |
+| `password` | `None` | Basic-Auth password |
+| `auto_refresh` | `True` | Enable auto-refresh |
+| `refresh_timer` | `5000` | Refresh interval (ms) |
+| `auto_scroll` | `True` | Auto-scroll to bottom |
+| `colorize` | `True` | Colour-coded levels |
+
+---
+
+## Using the Core API Directly
+
+The core classes have **zero dependencies** and can be used in any Python application:
+
+```python
+from python_log_viewer.core import LogDirectory, LogReader
+
+# Point to your log directory
+log_dir = LogDirectory("/var/log/myapp")
+
+# List all files
+for f in log_dir.list_files():
+    print(f"{f.name}  {f.size} bytes  modified={f.modified}")
+
+# Read and filter log entries
+reader = LogReader(log_dir)
+result = reader.read(
+    file="app.log",
+    lines=100,
+    level="ERROR",
+    search="database",
+)
+print(f"Total matching entries: {result['total']}")
+for line in result["lines"]:
+    print(line)
+
+# File operations
+log_dir.clear_file("app.log")    # truncate to 0 bytes
+log_dir.delete_file("old.log")   # permanently remove
+```
+
+---
+
+## Environment Variables
+
+Configuration can be set via environment variables (useful for Docker / CI):
+
+| Variable | Description |
+|----------|-------------|
+| `LOG_VIEWER_USERNAME` | Basic-Auth username |
+| `LOG_VIEWER_PASSWORD` | Basic-Auth password |
+
+---
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/imsujan276/python-log-viewer.git
+cd python-log-viewer
+
+# Install in editable mode
+pip install -e ".[all]"
+```
+
+---
+
+## License
+
+MIT

python_log_viewer-0.1.0/README.md

@@ -0,0 +1,243 @@
+# python-log-viewer
+
+A beautiful, real-time log viewer with a dark-themed web UI. Browse, search, filter, clear, and delete log files — all from your browser.
+
+Integrates seamlessly with **Django**, **Flask**, and **FastAPI**.
+
+![Log Viewer Preview](screenshots/preview.png)
+
+---
+
+## Features
+
+- 📁 **File browser** — sidebar with folder tree, file sizes
+- 🔍 **Search & filter** — full-text search, log-level filtering (DEBUG / INFO / WARNING / ERROR)
+- 🎨 **Colour-coded** — log levels highlighted with subtle background colours
+- 🔄 **Auto-refresh** — configurable live-tail (5s, 10s, 30s, 1m, or manual)
+- 📜 **Line limits** — last 500 / 1000 / 2500 / 5000 / all entries
+- 🗑️ **File actions** — clear (truncate) or delete log files with confirmation modals
+- 🔒 **Basic Auth** — optional HTTP Basic Authentication
+- 📱 **Responsive** — works on mobile with a slide-out sidebar
+---
+
+## Installation
+
+```bash
+pip install python-log-viewer
+```
+
+### Framework extras
+
+```bash
+pip install python-log-viewer[django]    # Django integration
+pip install python-log-viewer[flask]     # Flask integration
+pip install python-log-viewer[fastapi]   # FastAPI integration
+pip install python-log-viewer[all]       # All frameworks
+```
+
+---
+
+## Django Integration
+
+### 1. Install
+
+```bash
+pip install python-log-viewer[django]
+```
+
+### 2. Add to `INSTALLED_APPS`
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "python_log_viewer.contrib.django",
+]
+```
+
+### 3. Include URLs
+
+```python
+# urls.py
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path("logs/", include("python_log_viewer.contrib.django.urls")),
+]
+```
+
+### 4. Configure (optional)
+
+Add any of these to your `settings.py`:
+
+```python
+# Path to your log directory (default: BASE_DIR / "logs")
+LOG_VIEWER_DIR = BASE_DIR / "logs"
+
+# UI defaults
+LOG_VIEWER_AUTO_REFRESH  = True    # enable auto-refresh
+LOG_VIEWER_REFRESH_TIMER = 5000    # refresh interval in ms
+LOG_VIEWER_AUTO_SCROLL   = True    # auto-scroll to bottom
+LOG_VIEWER_COLORIZE      = True    # colour-coded log levels
+
+# Authentication (optional — leave unset to disable)
+LOG_VIEWER_USERNAME = "admin"
+LOG_VIEWER_PASSWORD = "secret"
+
+# Allow logged-in Django superusers to bypass Basic Auth (default: True)
+LOG_VIEWER_SUPERUSER_ACCESS = True
+```
+
+Then visit `http://localhost:8000/logs/` in your browser.
+
+---
+
+## Flask Integration
+
+### 1. Install
+
+```bash
+pip install python-log-viewer[flask]
+```
+
+### 2. Register the blueprint
+
+```python
+from flask import Flask
+from python_log_viewer.contrib.flask import create_log_viewer_blueprint
+
+app = Flask(__name__)
+
+app.register_blueprint(
+    create_log_viewer_blueprint(
+        log_dir="./logs",
+        url_prefix="/logs",
+        username="admin",      # optional
+        password="secret",     # optional
+    )
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+Then visit `http://localhost:5000/logs/` in your browser.
+
+**Blueprint parameters:**
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `log_dir` | `"./logs"` | Path to log directory |
+| `url_prefix` | `"/logs"` | URL prefix |
+| `username` | `None` | Basic-Auth username |
+| `password` | `None` | Basic-Auth password |
+| `auto_refresh` | `True` | Enable auto-refresh |
+| `refresh_timer` | `5000` | Refresh interval (ms) |
+| `auto_scroll` | `True` | Auto-scroll to bottom |
+| `colorize` | `True` | Colour-coded levels |
+
+---
+
+## FastAPI Integration
+
+### 1. Install
+
+```bash
+pip install python-log-viewer[fastapi]
+```
+
+### 2. Include the router
+
+```python
+from fastapi import FastAPI
+from python_log_viewer.contrib.fastapi import create_log_viewer_router
+
+app = FastAPI()
+
+app.include_router(
+    create_log_viewer_router(
+        log_dir="./logs",
+        prefix="/logs",
+        username="admin",      # optional
+        password="secret",     # optional
+    )
+)
+```
+
+Then visit `http://localhost:8000/logs/` in your browser.
+
+**Router parameters:**
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `log_dir` | `"./logs"` | Path to log directory |
+| `prefix` | `"/logs"` | URL prefix |
+| `username` | `None` | Basic-Auth username |
+| `password` | `None` | Basic-Auth password |
+| `auto_refresh` | `True` | Enable auto-refresh |
+| `refresh_timer` | `5000` | Refresh interval (ms) |
+| `auto_scroll` | `True` | Auto-scroll to bottom |
+| `colorize` | `True` | Colour-coded levels |
+
+---
+
+## Using the Core API Directly
+
+The core classes have **zero dependencies** and can be used in any Python application:
+
+```python
+from python_log_viewer.core import LogDirectory, LogReader
+
+# Point to your log directory
+log_dir = LogDirectory("/var/log/myapp")
+
+# List all files
+for f in log_dir.list_files():
+    print(f"{f.name}  {f.size} bytes  modified={f.modified}")
+
+# Read and filter log entries
+reader = LogReader(log_dir)
+result = reader.read(
+    file="app.log",
+    lines=100,
+    level="ERROR",
+    search="database",
+)
+print(f"Total matching entries: {result['total']}")
+for line in result["lines"]:
+    print(line)
+
+# File operations
+log_dir.clear_file("app.log")    # truncate to 0 bytes
+log_dir.delete_file("old.log")   # permanently remove
+```
+
+---
+
+## Environment Variables
+
+Configuration can be set via environment variables (useful for Docker / CI):
+
+| Variable | Description |
+|----------|-------------|
+| `LOG_VIEWER_USERNAME` | Basic-Auth username |
+| `LOG_VIEWER_PASSWORD` | Basic-Auth password |
+
+---
+
+## Development
+
+```bash
+# Clone
+git clone https://github.com/imsujan276/python-log-viewer.git
+cd python-log-viewer
+
+# Install in editable mode
+pip install -e ".[all]"
+```
+
+---
+
+## License
+
+MIT

python_log_viewer-0.1.0/examples/README.md

@@ -0,0 +1,27 @@
+# Examples
+
+Sample applications demonstrating `python-log-viewer` integration with each supported framework.
+
+All examples use the shared `sample_logs/` directory which contains realistic log files.
+
+| Example | Framework | Port | Command |
+|---------|-----------|------|---------|
+| [django_example](./django_example/) | Django | 8000 | `python manage.py runserver 8000` |
+| [flask_example](./flask_example/) | Flask | 5000 | `python app.py` |
+| [fastapi_example](./fastapi_example/) | FastAPI | 8000 | `uvicorn app:app --reload` |
+
+**Default credentials for all examples:** `admin` / `admin`
+
+## Quick Start
+
+```bash
+# 1. Install the package in editable mode with all extras
+cd /path/to/python-log-viewer
+pip install -e ".[all]"
+
+# 2. Pick an example and run it
+cd examples/flask_example
+python app.py
+```
+
+Then open the URL shown in the terminal.

python_log_viewer-0.1.0/examples/django_example/README.md

@@ -0,0 +1,18 @@
+# Django Example
+
+## Setup
+
+```bash
+# From the repository root
+pip install -e ".[django]"
+
+# Run the server
+cd examples/django_example
+python manage.py runserver 8000
+```
+
+## Usage
+
+Open http://localhost:8000/logs/ in your browser.
+
+**Credentials:** `admin` / `admin`

python_log_viewer-0.1.0/examples/fastapi_example/README.md

@@ -0,0 +1,18 @@
+# FastAPI Example
+
+## Setup
+
+```bash
+# From the repository root
+pip install -e ".[fastapi]"
+
+# Run the server
+cd examples/fastapi_example
+uvicorn app:app --host 0.0.0.0 --port 8000 --reload
+```
+
+## Usage
+
+Open http://localhost:8000/logs/ in your browser.
+
+**Credentials:** `admin` / `admin`

python_log_viewer-0.1.0/examples/flask_example/README.md

@@ -0,0 +1,18 @@
+# Flask Example
+
+## Setup
+
+```bash
+# From the repository root
+pip install -e ".[flask]"
+
+# Run the server
+cd examples/flask_example
+python app.py
+```
+
+## Usage
+
+Open http://localhost:5000/logs/ in your browser.
+
+**Credentials:** `admin` / `admin`

python_log_viewer-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-log-viewer"
+version = "0.1.0"
+description = "A beautiful, real-time log viewer with a web UI. Works with Django, Flask, and FastAPI."
+readme = "README.md"
+license = { text = "MIT" }
+license-files = []
+requires-python = ">=3.9"
+authors = [{ name = "Sujan Gainju", email = "sujangainju01@gmail.com" }]
+keywords = ["log", "viewer", "logging", "monitoring", "django", "flask", "fastapi", "web-ui"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: System :: Logging",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Framework :: Django",
+    "Framework :: Flask",
+    "Framework :: FastAPI",
+]
+
+[project.optional-dependencies]
+django = ["django>=3.2"]
+flask = ["flask>=2.0"]
+fastapi = ["fastapi>=0.68", "uvicorn>=0.15"]
+all = ["django>=3.2", "flask>=2.0", "fastapi>=0.68", "uvicorn>=0.15"]
+
+[project.urls]
+Homepage = "https://github.com/imsujan276/python-log-viewer"
+Repository = "https://github.com/imsujan276/python-log-viewer"
+Issues = "https://github.com/imsujan276/python-log-viewer/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/python_log_viewer"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/python_log_viewer/", "README.md", "LICENSE"]