dj-signals-panel 0.1.0

Display registered Django signals and receivers, showing what fires and where.

Dj Signals Panel

Display registered Django signals and receivers, showing what fires and where.

Docs

https://yassi.github.io/dj-signals-panel/

Features

• TBD: Add your main features here

Project Structure

dj-signals-panel/
├── dj_signals_panel/         # Main package
│   ├── templates/           # Django templates
│   ├── 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-signals-panel will appear in the same places where your models appear.

NOTE: This application does not actually introduce any model or migrations.

Installation

1. Install the Package

pip install dj-signals-panel

2. Add to Django Settings

Add dj_signals_panel to your INSTALLED_APPS:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'dj_signals_panel',  # Add this line
    # ... your other apps
]

3. Configure Settings (Optional)

Add any custom configuration to your Django settings if needed:

# Optional: Add custom settings for dj_signals_panel
DJ_SIGNALS_PANEL_SETTINGS = {
    'LOAD_DEFAULT_CSS': True,   # Set False to skip built-in styles
    # Static paths are relative to app's static/ dir (e.g. 'myapp/css/overrides.css'
    # for a file at myapp/static/myapp/css/overrides.css). Full URLs also accepted.
    'EXTRA_CSS': [],
}

4. Include URLs

Add the Panel URLs to your main urls.py:

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/dj-signals-panel/', include('dj_signals_panel.urls')),  # Add this line
    path('admin/', admin.site.urls),
]

5. Run Migrations and Create Superuser

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:

   python manage.py runserver
   

2. Navigate to the Django admin at http://127.0.0.1:8000/admin/

3. Look for the "DJ SIGNALS PANEL" section in the admin interface

License

This project is licensed under the MIT License. See the 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
• Docker

It is reccommended that you use docker since it will automate much of dev env setup

1. Clone the Repository

git clone https://github.com/yassi/dj-signals-panel.git
cd dj-signals-panel

2a. Set up dev environment using virtualenv

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

pip install -e . # install dj-signals-panel package locally
pip intall -r requirements.txt  # install all dev requirements

# Alternatively
make install # this will also do the above in one single command

2b. Set up dev environment using docker

make docker_up  # bring up all services (redis, memached) and dev environment container
make docker_shell  # open up a shell in the docker conatiner

3. Set Up Example Project

The repository includes an example Django project for development and testing

cd example_project
python manage.py migrate
python manage.py createsuperuser

4. Populate Test Data (Optional)

Add any custom management commands for populating test data if needed.

6. Run the Development Server

python manage.py runserver

Visit http://127.0.0.1:8000/admin/ to access the Django admin with Dj Signals Panel.

7. Running Tests

The project includes a comprehensive test suite. You can run them by using make or by invoking pytest directly:

# build and install all dev dependencies and run all tests inside of docker container
make test_docker

# Test without the docker on your host machine.
# note that testing always requires a redis and memcached service to be up.
# these are mostly easily brought up using docker
make test_local