django-orbit 0.2.0__tar.gz

django_orbit-0.2.0/CHANGELOG.md

@@ -0,0 +1,59 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2025-12-16
+
+### Added
+- **New Watchers**:
+  - `Commands`: Track management commands execution
+  - `Cache`: Monitor cache operations (get, set, delete)
+  - `Models`: Track model signals (save, delete) and lifecycle
+  - `HTTP Client`: Capture outgoing HTTP requests (httpx, requests)
+- **Helpers**:
+  - `dump()`: Helper for manual variable inspection (Laravel Telescope style)
+  - `log()`: Helper for direct logging to Orbit
+- **Dashboard**:
+  - Complete pagination system (25 entries/page)
+  - New entry types support with distinct icons and colors
+  - "Dumps" section in sidebar
+- **Configuration**:
+  - Added `RECORD_*` settings for new watchers
+  - Added `RECORD_DUMPS`
+
+### Fixed
+- Fixed HTMX processing for dynamic content loading
+- Fixed pagination state persistence during auto-refresh
+- Sidebar ordering (alphabetical)
+- "Load More" button issues on long lists
+- Accurate cache hit/miss detection using sentinel object
+
+## [0.1.0] - 2024-12-01
+
+### Added
+- Initial release of Django Orbit
+- `OrbitEntry` model for storing telemetry data
+- `OrbitMiddleware` for capturing HTTP requests/responses
+- SQL query recording with duplicate and slow query detection
+- `OrbitLogHandler` for Python logging integration
+- Exception tracking with full traceback capture
+- Modern dashboard UI with space theme
+- HTMX-powered live feed with 3-second polling
+- Alpine.js reactive slide-over detail panel
+- Entry grouping via `family_hash`
+- Configurable ignore paths
+- Sensitive data sanitization
+- Automatic cleanup of old entries
+
+### Technical
+- Django 4.0+ support
+- Python 3.9+ support
+- Tailwind CSS via CDN (no build step required)
+- HTMX for partial page updates
+- Alpine.js for reactive UI components
+- Lucide icons

django_orbit-0.2.0/CONTRIBUTING.md

@@ -0,0 +1,205 @@
+# Contributing to Django Orbit
+
+Thank you for your interest in contributing to Django Orbit! This document provides guidelines and information for contributors.
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.9 or higher
+- Django 4.0 or higher
+- Git
+
+### Setting Up Your Development Environment
+
+1. **Fork and clone the repository**
+
+```bash
+git clone https://github.com/astro-stack/django-orbit.git
+cd django-orbit
+```
+
+2. **Create a virtual environment**
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+3. **Install development dependencies**
+
+```bash
+pip install -e ".[dev]"
+```
+
+4. **Run the test suite**
+
+```bash
+pytest
+```
+
+## Code Style
+
+We use several tools to maintain code quality:
+
+- **Black** for code formatting
+- **isort** for import sorting
+- **Flake8** for linting
+- **mypy** for type checking
+
+Run all formatters and linters:
+
+```bash
+black orbit tests
+isort orbit tests
+flake8 orbit tests
+mypy orbit
+```
+
+## Making Changes
+
+### Branch Naming
+
+Use descriptive branch names:
+
+- `feature/add-redis-storage`
+- `fix/sql-recorder-crash`
+- `docs/update-installation-guide`
+
+### Commit Messages
+
+Follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
+
+```
+type(scope): description
+
+[optional body]
+
+[optional footer]
+```
+
+Types:
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code refactoring
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+
+### Pull Request Process
+
+1. Create a new branch from `main`
+2. Make your changes
+3. Add or update tests as needed
+4. Ensure all tests pass
+5. Update documentation if necessary
+6. Open a pull request with a clear description
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=orbit --cov-report=html
+
+# Run specific test file
+pytest tests/test_middleware.py
+
+# Run with verbose output
+pytest -v
+```
+
+### Writing Tests
+
+- Place tests in the `tests/` directory
+- Use pytest fixtures for common setup
+- Test both success and error cases
+- Mock external dependencies
+
+Example test:
+
+```python
+import pytest
+from django.test import RequestFactory
+from orbit.middleware import OrbitMiddleware
+from orbit.models import OrbitEntry
+
+@pytest.mark.django_db
+def test_middleware_captures_request():
+    factory = RequestFactory()
+    request = factory.get('/api/users/')
+    
+    middleware = OrbitMiddleware(lambda r: HttpResponse('OK'))
+    response = middleware(request)
+    
+    assert response.status_code == 200
+    assert OrbitEntry.objects.filter(type='request').exists()
+```
+
+## Architecture Overview
+
+### Key Components
+
+1. **Models** (`models.py`)
+   - `OrbitEntry`: Central storage for all telemetry data
+
+2. **Middleware** (`middleware.py`)
+   - `OrbitMiddleware`: Orchestrates request/response capture
+
+3. **Recorders** (`recorders.py`)
+   - SQL query interception using `connection.execute_wrapper`
+
+4. **Handlers** (`handlers.py`)
+   - `OrbitLogHandler`: Python logging integration
+
+5. **Views** (`views.py`)
+   - Dashboard and HTMX partial views
+
+### Data Flow
+
+```
+Request → OrbitMiddleware → Your App → Response
+              ↓                 ↓
+         SQL Recorder      Log Handler
+              ↓                 ↓
+           OrbitEntry ← ← ← ← ←
+```
+
+## Documentation
+
+### Updating Documentation
+
+- Keep the README.md up to date with new features
+- Update the CHANGELOG.md following Keep a Changelog format
+- Add docstrings to all public functions and classes
+
+### Building Documentation
+
+Currently, documentation is maintained in Markdown files. A full documentation site may be added in the future.
+
+## Release Process
+
+1. Update version in `pyproject.toml`
+2. Update `CHANGELOG.md`
+3. Create a git tag: `git tag v0.1.0`
+4. Push tags: `git push --tags`
+5. Build and publish to PyPI
+
+## Getting Help
+
+- Open an issue for bugs or feature requests
+- Use discussions for questions and ideas
+- Join our community chat (link TBD)
+
+## Code of Conduct
+
+Please be respectful and inclusive in all interactions. We follow the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
+
+## License
+
+By contributing to Django Orbit, you agree that your contributions will be licensed under the MIT License.

django_orbit-0.2.0/LICENSE

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

django_orbit-0.2.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+include CONTRIBUTING.md
+
+recursive-include orbit/templates *
+recursive-include orbit/static *
+recursive-include orbit/migrations *.py
+
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude .DS_Store