Merge pull request #6 from davidslusser/non_model_signals

adding support for user_login/user_logout signals

Author: davidslusser

.gitignore

@@ -133,4 +133,4 @@ dmypy.json
 *.iml
 
 
-signal_control_tests/local_test
+src/signal_control_tests/local_test

README.md

@@ -1,10 +1,12 @@
 # django-signalcontrol
-A django extension for dynamically enabling/disabling model-based signals. 
+A django extension for dynamically enabling/disabling signals. This application allows django signals to be disabled or
+enabled on-demand through the django admin interface. 
+
 
 | | |
 |--------------|------|
 | Author       | David Slusser |
-| Description  | A django extension for dynamically enabling/disabling model-based signals. |
+| Description  | A django extension for dynamically enabling/disabling signals. |
 | Requirements | `Python 3.x`<br>`Django 2.2.x` |
 
 
@@ -22,20 +24,26 @@ Documentation source files are available in the docs folder.
 # Features
 
 ### signal decorator
+SignalControl can be added to a signal with the provided decorator. In the signals.py file, import the signalcontrol
+decorator and add the signal_control decorator to the line directly above the signal definition. Example:
 
 
 ### admin interface
-
+An django admin interface for django-signalcontrol is available to set signals to enabled or disabled. This displays
+all signals that can be controlled, and lists the application, model, signal receiver and signal name.
+Additionally, full search is available and filters are available for each field.
+Signals can be enabled or disabled individually or in bulk.
 
 
 # Usage Example
 
-.. code-block:: python
+```python
+    from signalcontrol.decorators import signal_control
 
-@receiver(post_save, sender=MyCoolModel)
-@signal_control
-def msg_my_model_two(sender, instance, created, **kwargs):
-    """ some signal """
-    print("you just saved an instance of MyCoolModel")
+    @receiver(post_save, sender=MyCoolModel)
+    @signal_control
+    def msg_after_my_model_save(sender, instance, created, **kwargs):
+        """ some signal """
+        print("you just saved an instance of MyCoolModel")
+```
 
-..

docs/source/Stargate.png

@@ -3,10 +3,10 @@
 
 About
 =====
-django-signalcontrol is a reusable django application that adds dynamic control to model signals.
+django-signalcontrol is a reusable django application that adds dynamic control to signals.
 
 
-With signal_control added to a model signal, the signal can by enabled (default) or disabled from the django admin.
+With signal_control added to a signal, the signal can by enabled (default) or disabled from the django admin.
 An entry for the signal is added to the SignalControl table that includes a boolean field to enable/disable the signal.
 When a signal is disabled it will not execute when dispatched through the receiver, such as post_save.
 

docs/source/about.rst

@@ -9,19 +9,19 @@ This document details the features currently available in django-signalcontrol.
 
 Signal Detection
 ----------------
-Model signals are detected automatically when django starts. Any model signal with signal_control applied will be
-detected and automatically added (if not already present) in the SignalControl database table. An info message will be
-printed when django starts if a new signal with signal_control is discovered. It will look like this:
+Signals are scanned automatically when django starts. Any signal with signal_control applied will be detected and
+automatically added (if not already present) in the SignalControl database table. An info message will be printed
+when django starts if a new signal with signal_control is discovered. It will look like this:
 
-``INFO: registering msg_after_my_model_save in demo with SignalControl``
+``INFO: registering msg_after_my_model_save in my_app with SignalControl``
 
-In this example, 'msg_after_my_model_save' is the name of the signal, and 'demo' is the name of the django app.
+In this example, 'msg_after_my_model_save' is the name of the signal, and 'my_app' is the name of the django app.
 
 
 The signal_control Decorator
 ----------------------------
 
-SignalControl can be added to a model signal via a provided decorator. In the signal.py file, import the signalcontrol
+SignalControl can be added to a signal with the provided decorator. In the signals.py file, import the signalcontrol
 decorator and add the signal_control decorator to the line directly above the signal definition. Example:
 
 .. code-block:: python
@@ -40,8 +40,8 @@ decorator and add the signal_control decorator to the line directly above the si
 Admin Interface
 ---------------
 
-An django admin interface for django-signalcontrol is available to set model signals to enabled or disabled. This
-displays all model signals that can be controlled, and lists the application, model, signal receiver and signal name.
+An django admin interface for django-signalcontrol is available to set signals to enabled or disabled. This displays
+all model signals that can be controlled, and lists the application, model, signal receiver and signal name.
 Additionally, full search is available and filters are available for each field.
 Signals can be enabled or disabled individually or in bulk.
 

docs/source/features.rst

@@ -8,6 +8,7 @@ Version History
    :header: "Release", "Details"
    :widths: 20, 100
 
+   "0.0.6", "adding support for user_logged_in/user_login_failed/user_logged_out signals"
    "0.0.5", "fixed bug causing OperationalError on migrate"
    "0.0.4", "project structure updates"
    "0.0.3", "bug fixes and code cleanup"

docs/source/version_history.rst

@@ -11,6 +11,7 @@
 """
 
 import os
+import sys
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -37,7 +38,9 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
+    'django_extensions',
     'signalcontrol',
+    'test_app',
 ]
 
 MIDDLEWARE = [
@@ -119,3 +122,64 @@
 # https://docs.djangoproject.com/en/2.2/howto/static-files/
 
 STATIC_URL = '/static/'
+
+
+
+# LOGGING CONFIGURATION
+# ------------------------------------------------------------------------------
+LOG_PATH = "/Users/dslusser/code/django-signalcontrol/src/signal_control_tests/logs"
+if not os.path.join(LOG_PATH):
+    os.mkdir(LOG_PATH)
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'verbose': {
+            'format': "[%(asctime)s] %(levelname)s [%(filename)s:%(lineno)s] %(message)s",
+            'datefmt': "%Y/%b/%d %H:%M:%S"
+        },
+        'simple': {
+            'format': '%(levelname)s %(message)s'
+        },
+    },
+    'handlers': {
+        'django': {
+            'level': 'DEBUG',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': '{}/django.log'.format(LOG_PATH),
+            'maxBytes': 1024 * 1024 * 15,
+            'backupCount': 10,
+            'formatter': 'verbose',
+        },
+        'user': {
+            'level': 'INFO',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': '{}/user.log'.format(LOG_PATH),
+            'maxBytes': 1024 * 1024 * 15,
+            'backupCount': 10,
+            'formatter': 'verbose',
+        },
+        'console': {
+            'level': 'INFO',
+            'class': 'logging.StreamHandler',
+            'stream': sys.stdout,
+            'formatter': 'verbose',
+        },
+
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['django', 'console'],
+            'level': 'INFO',
+        },
+        'user': {
+            'handlers': ['user', 'console'],
+            'level': 'INFO',
+        },
+        '': {
+            'handlers': ['console'],
+            'level': 'INFO',
+        }
+    },
+}

src/signal_control_tests/signal_control_tests/settings.py

@@ -0,0 +1 @@
+default_app_config = 'test_app.apps.TestAppConfig'

src/signal_control_tests/signalcontrol/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

src/signal_control_tests/signalcontrol/apps.py

@@ -0,0 +1,10 @@
+from django.apps import AppConfig
+
+
+class TestAppConfig(AppConfig):
+    name = 'test_app'
+
+    verbose_name = "test application for signalcontrol"
+
+    def ready(self):
+        import test_app.signals

src/signal_control_tests/signalcontrol/migrations/0001_initial.py

@@ -0,0 +1,35 @@
+# Generated by Django 2.2.12 on 2020-06-14 21:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MyModelOne',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=16)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='MyModelThree',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=16)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='MyModelTwo',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=16)),
+            ],
+        ),
+    ]

src/signal_control_tests/signalcontrol/migrations/__init__.py

@@ -0,0 +1,14 @@
+from django.db import models
+
+
+# Create your models here.
+class MyModelOne(models.Model):
+    name = models.CharField(max_length=16)
+
+
+class MyModelTwo(models.Model):
+    name = models.CharField(max_length=16)
+
+
+class MyModelThree(models.Model):
+    name = models.CharField(max_length=16)