dj-cache-panel 0.1.0__tar.gz

dj_cache_panel-0.1.0/LICENSE

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

dj_cache_panel-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+recursive-include dj_cache_panel/templates *

dj_cache_panel-0.1.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: dj-cache-panel
+Version: 0.1.0
+Summary: A Django Admin panel for browsing and inspecting Django cache backends
+Author: Yasser Toruno
+Maintainer: Yasser Toruno
+License: MIT
+Project-URL: Homepage, https://yassi.github.io/dj-cache-panel/
+Project-URL: Documentation, https://yassi.github.io/dj-cache-panel/
+Project-URL: Repository, https://github.com/yassi/dj-cache-panel
+Project-URL: Bug Tracker, https://github.com/yassi/dj-cache-panel/issues
+Keywords: django,cache,admin,panel,caching,django-cache
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: License :: OSI Approved :: MIT License
+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: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.2.0; extra == "dev"
+Requires-Dist: pymemcache>=4.0.0; extra == "dev"
+Requires-Dist: django-redis>=5.0.0; extra == "dev"
+Requires-Dist: mkdocs-material>=9.1.12; extra == "dev"
+Provides-Extra: build
+Requires-Dist: build>=1.0.0; extra == "build"
+Requires-Dist: twine>=4.0.0; extra == "build"
+Dynamic: license-file
+
+# Django Cache Panel
+
+A Django Admin panel for browsing, inspecting, and managing Django cache backends defined in your `CACHES` setting.
+
+![Django Cache Panel - Instance List](https://raw.githubusercontent.com/yassi/dj-cache-panel/main/images/instances_list.png)
+
+## Docs
+
+[https://yassi.github.io/dj-cache-panel/](https://yassi.github.io/dj-cache-panel/)
+
+## Features
+
+- **Browse Cache Keys**: Search and filter cache keys with pattern matching
+- **Key Management**: View, edit, and delete cache keys with support for all data types
+- **Feature Toggles**: Granular control over operations (delete, edit, TTL updates)
+- **Django Admin Integration**: Seamless integration with Django admin styling and dark mode
+- **Permission Control**: Respects Django admin permissions and staff-only access
+- **Multiple Instances**: Support for multiple cache backends with different configurations
+
+## Supported Cache Data Types
+
+- **String**: View and edit string values.
+
+
+### Project Structure
+
+```
+dj-cache-panel/
+├── dj_cache_panel/          # Main package
+│   ├── templates/           # Django templates
+│   ├── cache_utils.py       # Cache utilities
+│   ├── views.py             # Django views
+│   └── urls.py              # URL patterns
+├── example_project/         # Example Django project
+├── tests/                   # Test suite
+├── images/                  # Screenshots for README
+└── requirements.txt         # Development dependencies
+```
+
+## Requirements
+
+- Python 3.9+
+- Django 4.2+
+
+
+
+## Screenshots
+
+### Django Admin Integration
+Seamlessly integrated into your Django admin interface. A new section for dj-cache-panel
+will appear in the same places where your models appear.
+
+**NOTE:** This application does not actually introduce any model or migrations.
+
+![Admin Home](https://raw.githubusercontent.com/yassi/dj-cache-panel/main/images/admin_home.png)
+
+### Caches Overview
+Monitor your cache instances with detailed metrics and database information.
+
+![Instance Overview](https://raw.githubusercontent.com/yassi/dj-cache-panel/main/images/instance_overview.png)
+
+
+## Installation
+
+### 1. Install the Package
+
+```bash
+pip install dj-cache-panel
+```
+
+### 2. Add to Django Settings
+
+Add `dj_cache_panel` to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'dj_cache_panel',  # Add this line
+    # ... your other apps
+]
+```
+
+### 3. Configure Cache Instances
+
+Django cache panel will use the `CACHES` setting normally defined in django projects
+
+```python
+CACHES = {
+    ...
+}
+```
+
+
+### 4. Include URLs
+
+Add the Cache Panel URLs to your main `urls.py`:
+
+```python
+from django.contrib import admin
+from django.urls import path, include
+
+urlpatterns = [
+    path('admin/cache/', include('dj_cache_panel.urls')),  # Add this line
+    path('admin/', admin.site.urls),
+]
+```
+
+### 5. Run Migrations and Create Superuser
+
+```bash
+python manage.py migrate
+python manage.py createsuperuser  # If you don't have an admin user
+```
+
+### 6. Access the Panel
+
+1. Start your Django development server:
+   ```bash
+   python manage.py runserver
+   ```
+
+2. Navigate to the Django admin at `http://127.0.0.1:8000/admin/`
+
+3. Look for the "DJ_CACHE_PANEL" section in the admin interface
+
+4. Click "Manage Cache keys and values" to start browsing your cache instances
+
+
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Development Setup
+
+If you want to contribute to this project or set it up for local development:
+
+### Prerequisites
+
+- Python 3.9 or higher
+- Redis server running locally
+- Git
+- Autoconf
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/yassi/dj-cache-panel.git
+cd dj-cache-panel
+```
+
+### 2. Create Virtual Environment
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+### 3. Install dj-cache-panel inside of your virtualenv
+
+A make file is included in the repository root with multiple commands for building
+and maintaining this project. The best approach is to start by using one of the
+package installation commands found below:
+```bash
+# Install all dependencies and dj-cache-panel into your current env
+make install
+```
+
+### 4. Set Up Example Project
+
+The repository includes an example Django project for development and testing:
+
+```bash
+cd example_project
+python manage.py migrate
+python manage.py createsuperuser
+```
+
+### 5. Populate Test Data (Optional)
+An optional CLI tool for populating cache keys automatically is included in the
+example django project in this code base.
+
+```bash
+python manage.py populate_redis
+```
+
+This command will populate your cache instance with sample data for testing.
+
+### 6. Run the Development Server
+
+```bash
+python manage.py runserver
+```
+
+Visit `http://127.0.0.1:8000/admin/` to access the Django admin with Cache Panel.
+
+### 7. Running Tests
+
+The project includes a comprehensive test suite. You can run them by using make or
+by invoking pytest directly:
+
+```bash
+# build and install all dev dependencies and run all tests inside of docker container
+make test
+
+# Additionally generate coverage reports in multiple formats
+make test_coverage
+```
+
+**Note**: Tests require a running cache backend (e.g., Redis) on `127.0.0.1:6379`. The tests use databases 13, 14, and 15 for isolation and automatically clean up after each test.
+
+### 8. Dockerized Cache Backend
+
+Test for this project (as well as any active development) require an active cache backend installation.
+Although not required, a docker-compose file is included to allow for easy creation of local
+cache instances using redis, memcached, local memory, etc.
+
+```bash
+# Start Redis on localhost and the usual port 6379
+docker-compose up -d
+```

dj_cache_panel-0.1.0/README.md

@@ -0,0 +1,228 @@
+# Django Cache Panel
+
+A Django Admin panel for browsing, inspecting, and managing Django cache backends defined in your `CACHES` setting.
+
+![Django Cache Panel - Instance List](https://raw.githubusercontent.com/yassi/dj-cache-panel/main/images/instances_list.png)
+
+## Docs
+
+[https://yassi.github.io/dj-cache-panel/](https://yassi.github.io/dj-cache-panel/)
+
+## Features
+
+- **Browse Cache Keys**: Search and filter cache keys with pattern matching
+- **Key Management**: View, edit, and delete cache keys with support for all data types
+- **Feature Toggles**: Granular control over operations (delete, edit, TTL updates)
+- **Django Admin Integration**: Seamless integration with Django admin styling and dark mode
+- **Permission Control**: Respects Django admin permissions and staff-only access
+- **Multiple Instances**: Support for multiple cache backends with different configurations
+
+## Supported Cache Data Types
+
+- **String**: View and edit string values.
+
+
+### Project Structure
+
+```
+dj-cache-panel/
+├── dj_cache_panel/          # Main package
+│   ├── templates/           # Django templates
+│   ├── cache_utils.py       # Cache utilities
+│   ├── views.py             # Django views
+│   └── urls.py              # URL patterns
+├── example_project/         # Example Django project
+├── tests/                   # Test suite
+├── images/                  # Screenshots for README
+└── requirements.txt         # Development dependencies
+```
+
+## Requirements
+
+- Python 3.9+
+- Django 4.2+
+
+
+
+## Screenshots
+
+### Django Admin Integration
+Seamlessly integrated into your Django admin interface. A new section for dj-cache-panel
+will appear in the same places where your models appear.
+
+**NOTE:** This application does not actually introduce any model or migrations.
+
+![Admin Home](https://raw.githubusercontent.com/yassi/dj-cache-panel/main/images/admin_home.png)
+
+### Caches Overview
+Monitor your cache instances with detailed metrics and database information.
+
+![Instance Overview](https://raw.githubusercontent.com/yassi/dj-cache-panel/main/images/instance_overview.png)
+
+
+## Installation
+
+### 1. Install the Package
+
+```bash
+pip install dj-cache-panel
+```
+
+### 2. Add to Django Settings
+
+Add `dj_cache_panel` to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'dj_cache_panel',  # Add this line
+    # ... your other apps
+]
+```
+
+### 3. Configure Cache Instances
+
+Django cache panel will use the `CACHES` setting normally defined in django projects
+
+```python
+CACHES = {
+    ...
+}
+```
+
+
+### 4. Include URLs
+
+Add the Cache Panel URLs to your main `urls.py`:
+
+```python
+from django.contrib import admin
+from django.urls import path, include
+
+urlpatterns = [
+    path('admin/cache/', include('dj_cache_panel.urls')),  # Add this line
+    path('admin/', admin.site.urls),
+]
+```
+
+### 5. Run Migrations and Create Superuser
+
+```bash
+python manage.py migrate
+python manage.py createsuperuser  # If you don't have an admin user
+```
+
+### 6. Access the Panel
+
+1. Start your Django development server:
+   ```bash
+   python manage.py runserver
+   ```
+
+2. Navigate to the Django admin at `http://127.0.0.1:8000/admin/`
+
+3. Look for the "DJ_CACHE_PANEL" section in the admin interface
+
+4. Click "Manage Cache keys and values" to start browsing your cache instances
+
+
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Development Setup
+
+If you want to contribute to this project or set it up for local development:
+
+### Prerequisites
+
+- Python 3.9 or higher
+- Redis server running locally
+- Git
+- Autoconf
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/yassi/dj-cache-panel.git
+cd dj-cache-panel
+```
+
+### 2. Create Virtual Environment
+
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+### 3. Install dj-cache-panel inside of your virtualenv
+
+A make file is included in the repository root with multiple commands for building
+and maintaining this project. The best approach is to start by using one of the
+package installation commands found below:
+```bash
+# Install all dependencies and dj-cache-panel into your current env
+make install
+```
+
+### 4. Set Up Example Project
+
+The repository includes an example Django project for development and testing:
+
+```bash
+cd example_project
+python manage.py migrate
+python manage.py createsuperuser
+```
+
+### 5. Populate Test Data (Optional)
+An optional CLI tool for populating cache keys automatically is included in the
+example django project in this code base.
+
+```bash
+python manage.py populate_redis
+```
+
+This command will populate your cache instance with sample data for testing.
+
+### 6. Run the Development Server
+
+```bash
+python manage.py runserver
+```
+
+Visit `http://127.0.0.1:8000/admin/` to access the Django admin with Cache Panel.
+
+### 7. Running Tests
+
+The project includes a comprehensive test suite. You can run them by using make or
+by invoking pytest directly:
+
+```bash
+# build and install all dev dependencies and run all tests inside of docker container
+make test
+
+# Additionally generate coverage reports in multiple formats
+make test_coverage
+```
+
+**Note**: Tests require a running cache backend (e.g., Redis) on `127.0.0.1:6379`. The tests use databases 13, 14, and 15 for isolation and automatically clean up after each test.
+
+### 8. Dockerized Cache Backend
+
+Test for this project (as well as any active development) require an active cache backend installation.
+Although not required, a docker-compose file is included to allow for easy creation of local
+cache instances using redis, memcached, local memory, etc.
+
+```bash
+# Start Redis on localhost and the usual port 6379
+docker-compose up -d
+```

dj_cache_panel-0.1.0/dj_cache_panel/__init__.py

@@ -0,0 +1,3 @@
+import logging
+
+logging.getLogger(__name__).addHandler(logging.NullHandler())

dj_cache_panel-0.1.0/dj_cache_panel/admin.py

@@ -0,0 +1,27 @@
+from django.contrib import admin
+from django.http import HttpResponseRedirect
+from django.urls import reverse
+
+
+from .models import CachePanelPlaceholder
+
+
+@admin.register(CachePanelPlaceholder)
+class CachePanelPlaceholderAdmin(admin.ModelAdmin):
+    def changelist_view(self, request, extra_context=None):
+        # The @staff_member_required decorator on the view will handle auth
+        return HttpResponseRedirect(reverse("dj_cache_panel:index"))
+
+    def has_add_permission(self, request):
+        return False
+
+    def has_change_permission(self, request, obj=None):
+        # Allow staff members to "view" the Cache panel
+        return request.user.is_staff
+
+    def has_delete_permission(self, request, obj=None):
+        return False
+
+    def has_view_permission(self, request, obj=None):
+        # Allow staff members to view the Cache panel
+        return request.user.is_staff

dj_cache_panel-0.1.0/dj_cache_panel/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class DjCachePanelConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "dj_cache_panel"
+    verbose_name = "Django Panels - Cache"

dj_cache_panel-0.1.0/dj_cache_panel/models.py

@@ -0,0 +1,14 @@
+from django.db import models
+
+
+class CachePanelPlaceholder(models.Model):
+    """
+    This is a fake model used to create an entry in the admin panel for the cache panel.
+    When we register this app with the admin site, it is configured to simply load
+    the cache panel templates.
+    """
+
+    class Meta:
+        managed = False
+        verbose_name = "Django Cache Panel"
+        verbose_name_plural = "Django Cache Panel"

dj_cache_panel-0.1.0/dj_cache_panel/templates/admin/dj_cache_panel/base.html

@@ -0,0 +1,24 @@
+{% extends "admin/base_site.html" %}
+{% load i18n admin_urls static admin_list %}
+
+{% block title %}{{ title }} | DJ Cache Panel{% endblock %}
+
+{% block extrahead %}
+<style type="text/css">
+    {% include "admin/dj_cache_panel/styles.css" %}
+</style>
+{% endblock %}
+
+{% block branding %}
+<h1 id="site-name"><a href="{% url 'dj_cache_panel:index' %}">DJ Cache Panel</a></h1>
+{% endblock %}
+
+{% block breadcrumbs %}
+<div class="breadcrumbs">
+<a href="{% url 'admin:index' %}">{% trans 'Home' %}</a>
+&rsaquo; {{ title }}
+</div>
+{% endblock %}
+
+{% block content %}
+{% endblock %}

dj_cache_panel-0.1.0/dj_cache_panel/templates/admin/dj_cache_panel/index.html

@@ -0,0 +1,64 @@
+{% extends "admin/dj_cache_panel/base.html" %}
+{% load i18n admin_urls static admin_list %}
+
+{% block content %}
+<div class="module">
+    {% if caches %}
+    <h2>{% trans 'Cache Instances' %}</h2>
+    <br>
+    <div class="results">
+        <table id="result_list">
+            <thead>
+                <tr>
+                    <th>Cache Name</th>
+                    <th>Backend</th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for cache_name, cache_config in caches.items %}
+                <tr>
+                    <td>{{ cache_name }}</td>
+                    <td>{{ cache_config.BACKEND }}</td>
+                </tr>
+                {% endfor %}
+            </table>
+    </div>
+    {% else %}
+    <div class="aligned">
+        <fieldset class="module">
+            <h2>{% trans 'Cache Configuration Required' %}</h2>
+            
+            <div class="form-row">
+                <div class="help-text">
+                    <p>{% trans 'To use the Cache panel, you must configure cache instances in your Django settings.' %}</p>
+                </div>
+            </div>
+
+            <div class="form-row">
+                <h3>{% trans 'Please add a configuration dictionary to your settings.py like the example below:' %}</h3>
+                <fieldset class="collapse">
+                    <div class="form-row">
+                        <textarea readonly rows="25" class="vLargeTextField" style="font-family: monospace; width: 100%;">
+CACHES = {
+    "default": {
+        "BACKEND": "django.core.cache.backends.redis.RedisCache",
+        "LOCATION": "redis://127.0.0.1:6379",
+    }
+}
+</textarea>
+                    </div>
+                </fieldset>
+            </div>
+
+            
+
+            <div class="form-row">
+                <div class="help-text">
+                    <p><strong>{% trans 'After adding the configuration, restart your Django server to see your Cache instances.' %}</strong></p>
+                </div>
+            </div>
+        </fieldset>
+    </div>
+    {% endif %}
+</div>
+{% endblock %}