Fix in doc

Author: synw

docsite/components.d.ts

@@ -9,22 +9,12 @@ export {}
 declare module 'vue' {
   export interface GlobalComponents {
     DefaultSidebar: typeof import('./src/components/sidebars/DefaultSidebar.vue')['default']
-    DispatchRoutePy: typeof import('./src/components/python/DispatchRoutePy.vue')['default']
     'IEva:arrowBackOutline': typeof import('~icons/eva/arrow-back-outline')['default']
-    'IFa6Brands:github': typeof import('~icons/fa6-brands/github')['default']
     'IFaBrands:github': typeof import('~icons/fa-brands/github')['default']
     'IFaSolid:moon': typeof import('~icons/fa-solid/moon')['default']
     'IFaSolid:sun': typeof import('~icons/fa-solid/sun')['default']
-    'INoto:crocodile': typeof import('~icons/noto/crocodile')['default']
-    'IPh:caretDownBold': typeof import('~icons/ph/caret-down-bold')['default']
-    'IPh:caretRightBold': typeof import('~icons/ph/caret-right-bold')['default']
-    PythonSidebar: typeof import('./src/components/sidebars/PythonSidebar.vue')['default']
-    RenderMd: typeof import('./src/components/markdown/RenderMd.vue')['default']
-    RenderMdPy: typeof import('./src/components/python/RenderMdPy.vue')['default']
-    RenderPyDocstring: typeof import('./src/components/python/RenderPyDocstring.vue')['default']
     RouterLink: typeof import('vue-router')['RouterLink']
     RouterView: typeof import('vue-router')['RouterView']
-    StaticPyCodeBlock: typeof import('./src/components/python/StaticPyCodeBlock.vue')['default']
     TheHeader: typeof import('./src/components/TheHeader.vue')['default']
     TheSidebar: typeof import('./src/components/TheSidebar.vue')['default']
   }

docsite/src/assets/README.md

@@ -0,0 +1,46 @@
+# Django Mqueue
+
+Events queue application for Django. Features:
+
+- **Monitor models**: models can be registered to autogenerate events on create/update/delete actions
+- **Export events**: save events to Redis or send them over websockets
+
+:books: Read the [documentation](/)
+
+Example:
+
+   ```python
+   MEvent.objects.create(name="Test event", event_class="test", data={"k":"v"})
+   ```
+
+Events can be linked to a model instance and a user instance.
+
+![Event queue screenshot](https://raw.github.com/synw/django-mqueue/master/docsite/src/assets/screenshot.png)
+
+## Real time events demo
+
+A websockets demo: [django-mqueue-livefeed](https://github.com/synw/django-mqueue-livefeed) is available
+
+## Documentation
+
+ - [Get started](/get_started)
+    - [Install](/get_started/install)
+    - [Basics](/get_started/basics)
+ - [Events](/events)
+    - [Parameters](/events/parameters)
+    - [Fields autoguess](/events/fields_autoguess)
+    - [Query events](/events/query_events)
+ - [Model events](/model_events)
+    - [Registered models](/model_events/registered_models)
+    - [Watchers](/model_events/watchers)
+ - [Post processing](/post_processing)
+    - [Model callbacks](/post_processing/model_callbacks)
+    - [Hooks](/post_processing/hooks)
+     - [Hooks](/post_processing/hooks)
+        - [Redis](/post_processing/hooks/redis)
+        - [Centrifugo](/post_processing/hooks/centrifugo)
+        - [Custom](/post_processing/hooks/custom)
+ - [Extra](/extra)
+    - [Livefeed](/extra/livefeed)
+    - [Logs handler](/extra/logs_handler)
+    - [Graphical settings](/extra/graphical_settings)

docsite/src/assets/py/events/fields_autoguess.py

@@ -0,0 +1,13 @@
+import json
+from django.forms.models import model_to_dict
+from django.contrib.auth.models import User
+from mqueue.models import MEvent
+
+user, _  = User.objects.get_or_create(username="someuser", password="xxxyyyzzz")
+
+MEvent.objects.create(name = 'A user event', instance=user, bucket="autoguess_test")
+
+for event in list(
+  MEvent.objects.events_for_model(User).filter(bucket="autoguess_test")
+):
+  print(json.dumps(model_to_dict(event), indent=4))

docsite/src/assets/py/events/models.py

@@ -0,0 +1,17 @@
+from django.db import models
+from django.contrib.auth import get_user_model
+
+USER_MODEL = get_user_model()
+
+class MyModel(models.Model):
+    name = models.CharField(max_length=120)
+    user = models.ForeignKey(
+        USER_MODEL,
+        null=True,
+        blank=True,
+        related_name="+",
+        on_delete=models.SET_NULL,
+    )
+
+    def get_event_object_url(self) -> str:
+        return f"/some/url/{self.name}"

docsite/src/assets/py/events/parameters.py

@@ -0,0 +1,21 @@
+from mqueue.models import MEvent
+from myapp.models import MyModel
+
+obj = MyModel.objects.get(x="y")
+
+MEvent.objects.create(
+   name = obj.title,
+   event_class = 'Info',
+   bucket = "bucket_name",
+   data = {"foo": "bar"},
+   scope = "users",
+   model = MyModel,
+   obj_pk =obj.pk,
+   instance = obj,
+   user = request.user,
+   url ='/anything/'+obj.slug+'/',
+   admin_url ='/admin/app/model/'+str(obj.pk)+'/',
+   notes = 'Object X was saved!',
+   request = request,
+   groups = [group1]
+)

docsite/src/assets/py/events/query.py

@@ -0,0 +1,12 @@
+import json
+from django.forms.models import model_to_dict
+from django.contrib.auth.models import Group
+from mqueue.models import MEvent
+
+MEvent.objects.create(name = 'A group event', model=Group)
+MEvent.objects.create(name = 'A group event', model=Group)
+
+for event in list(
+  MEvent.objects.events_for_model(Group)
+):
+  print(f"- {event}")

docsite/src/assets/py/events/query2.py

@@ -0,0 +1,23 @@
+import json
+from django.forms.models import model_to_dict
+from django.contrib.auth.models import Group, User
+from mqueue.models import MEvent
+
+g1, _ = Group.objects.get_or_create(name="g1")
+g2, _ = Group.objects.get_or_create(name="g2")
+
+MEvent.objects.create(name = 'A group event', instance=g1)
+MEvent.objects.create(name = 'A group event', instance=g1)
+MEvent.objects.create(name = 'A group event', instance=g2)
+
+print("Events for group 1:")
+for event in list(
+  MEvent.objects.events_for_object(g1)
+):
+  print(f"  - {event}")
+
+print("Events for group 2:")
+for event in list(
+  MEvent.objects.events_for_object(g2)
+):
+  print(f"  - {event}")

docsite/src/assets/py/events/query3.py

@@ -0,0 +1,18 @@
+from mqueue.models import MEvent
+
+MEvent.objects.create(
+  name = 'An event',
+  event_class="Info",
+  bucket="bucket1",
+  data= [1, 2],
+  notes="special"
+)
+
+events = MEvent.objects.filter(
+  event_class="Info",
+  bucket="bucket1",
+  notes="special"
+)
+
+event = events[0]
+print(f"  - {event.event_class} {event.name} {event.data}")

docsite/src/assets/py/get_started/date.py

@@ -0,0 +1,8 @@
+from  django.utils import timezone
+from mqueue.models import MEvent
+
+now = timezone.now()
+MEvent.objects.create(name = 'Event now')
+events = MEvent.objects.filter(date_posted__gte=now)
+for event in events:
+    print(event)

docsite/src/assets/py/get_started/qs.py

@@ -0,0 +1,8 @@
+from mqueue.models import MEvent
+
+MEvent.objects.create(name = 'Event 1', event_class="Info")
+MEvent.objects.create(name = 'Event 2', event_class="Warning")
+MEvent.objects.create(name = 'Event 3', event_class="Error")
+events = MEvent.objects.all()
+for event in events:
+    print(event.event_class, event)