django-content-studio 1.0.0a1__py3-none-any.whl → 1.0.0b1__py3-none-any.whl

content_studio/views.py

@@ -1,5 +1,7 @@
+from django.conf import settings
 from django.contrib import admin
 from django.urls import reverse, NoReverseMatch
+from django.utils.translation import gettext_lazy as _
 from django.views.generic import TemplateView
 from rest_framework.decorators import action
 from rest_framework.permissions import IsAdminUser, AllowAny
@@ -7,9 +9,11 @@ from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
 from rest_framework.viewsets import ViewSet
 
-from .admin import AdminSerializer, admin_site
+from . import __version__
+from .admin import AdminSerializer, ModelGroup
 from .models import ModelSerializer
-from .serializers import CurrentUserSerializer
+from .serializers import SessionUserSerializer
+from .settings import cs_settings
 
 
 class ContentStudioWebAppView(TemplateView):
@@ -22,7 +26,7 @@ class ContentStudioWebAppView(TemplateView):
 
 class AdminApiViewSet(ViewSet):
     """
-    Viewset for special admin endpoints.
+    View set for content studio admin endpoints.
     """
 
     permission_classes = [IsAdminUser]
@@ -38,8 +42,10 @@ class AdminApiViewSet(ViewSet):
         """
         Returns public information about the Content Studio admin.
         """
+        admin_site = cs_settings.ADMIN_SITE
 
         data = {
+            "version": __version__,
             "site_header": admin_site.site_header,
             "site_title": admin_site.site_title,
             "index_title": admin_site.index_title,
@@ -50,6 +56,17 @@ class AdminApiViewSet(ViewSet):
                 for backend in admin_site.login_backend.active_backends
             ],
             "token_backend": admin_site.token_backend.active_backend.get_info(),
+            "formats": {
+                model_class.__name__: frmt.serialize()
+                for model_class, frmt in admin_site.default_format_mapping.items()
+            },
+            "widgets": get_widgets(),
+            "settings": {
+                "created_by_attr": cs_settings.CREATED_BY_ATTR,
+                "created_at_attr": cs_settings.CREATED_AT_ATTR,
+                "edited_by_attr": cs_settings.EDITED_BY_ATTR,
+                "edited_at_attr": cs_settings.EDITED_AT_ATTR,
+            },
         }
 
         return Response(data=data)
@@ -66,16 +83,29 @@ class AdminApiViewSet(ViewSet):
         """
         Returns information about the Django app (models, admin models, admin site, settings, etc.).
         """
-        data = {"models": []}
-        registered_models = admin.site._registry
+        admin_site = cs_settings.ADMIN_SITE
+        data = {
+            "models": get_models(request),
+            "model_groups": get_model_groups(),
+            "user_model": settings.AUTH_USER_MODEL,
+        }
+
+        media_model = cs_settings.MEDIA_LIBRARY_MODEL
+        folder_model = cs_settings.MEDIA_LIBRARY_FOLDER_MODEL
+
+        data["media_library"] = {
+            "enabled": media_model is not None,
+            "folders": folder_model is not None,
+            "models": {
+                "media_model": media_model._meta.label_lower,
+                "folder_model": folder_model._meta.label_lower,
+            },
+        }
 
-        for model, admin_class in registered_models.items():
-            data["models"].append(
-                {
-                    **ModelSerializer(model).serialize(),
-                    "admin": AdminSerializer(admin_class).serialize(request),
-                }
-            )
+        if admin_site.dashboard:
+            data["dashboard"] = admin_site.dashboard.serialize()
+        else:
+            data["dashboard"] = {"widgets": []}
 
         return Response(data=data)
 
@@ -84,7 +114,64 @@ class AdminApiViewSet(ViewSet):
         """
         Returns information about the current user.
         """
-        return Response(CurrentUserSerializer(request.user).data)
+        return Response(SessionUserSerializer(request.user).data)
+
+
+def get_models(request):
+    models = []
+    registered_models = admin.site._registry
+
+    for model, admin_class in registered_models.items():
+        models.append(
+            {
+                **ModelSerializer(model).serialize(),
+                "admin": AdminSerializer(admin_class).serialize(request),
+            }
+        )
+        for inline in admin_class.inlines:
+            if inline.model not in registered_models:
+                models.append(
+                    {
+                        **ModelSerializer(inline.model).serialize(),
+                    }
+                )
+
+    return models
+
+
+def get_model_groups():
+    admin_site = cs_settings.ADMIN_SITE
+
+    default_group = [
+        ModelGroup(
+            label=_("Content"),
+            name="default",
+            icon=None,
+            models=[model for model, admin_model in admin.site._registry.items()],
+        )
+    ]
+    # Get custom model groups or use the default one
+    model_groups = getattr(admin_site, "model_groups", None) or default_group
+
+    return [
+        {
+            "name": group.name,
+            "icon": group.icon,
+            "color": group.color,
+            "label": group.label,
+            "models": [m._meta.label_lower for m in group.models],
+        }
+        for group in model_groups
+    ]
+
+
+def get_widgets():
+    admin_site = cs_settings.ADMIN_SITE
+
+    return {
+        (m if isinstance(m, str) else m.__name__): widget.serialize()
+        for m, widget in admin_site.default_widget_mapping.items()
+    }
 
 
 def get_health_check_path():

content_studio/viewsets.py

@@ -1,58 +1,32 @@
 from django.contrib.admin.models import LogEntry, ADDITION, CHANGE, DELETION
 from django.contrib.contenttypes.models import ContentType
-from rest_framework.exceptions import MethodNotAllowed, NotFound
+from rest_framework.exceptions import NotFound
 from rest_framework.filters import SearchFilter, OrderingFilter
-from rest_framework.pagination import PageNumberPagination
 from rest_framework.parsers import JSONParser
 from rest_framework.permissions import DjangoModelPermissions
 from rest_framework.renderers import JSONRenderer
 from rest_framework.viewsets import ModelViewSet
 
-from .admin import admin_site
+from .filters import LookupFilter
 from .settings import cs_settings
 
 
 class BaseModelViewSet(ModelViewSet):
     lookup_field = "id"
+    is_singleton = False
     parser_classes = [JSONParser]
     renderer_classes = [JSONRenderer]
     permission_classes = [DjangoModelPermissions]
-    pagination_class = [PageNumberPagination]
-    filter_backends = [SearchFilter, OrderingFilter]
+    filter_backends = [SearchFilter, OrderingFilter, LookupFilter]
 
-    def __init__(self):
+    def __init__(self, *args, **kwargs):
         super(BaseModelViewSet, self).__init__()
+        admin_site = cs_settings.ADMIN_SITE
 
         self.authentication_classes = [
-            admin_site.auth_backend.active_backend.authentication_class
+            admin_site.token_backend.active_backend.authentication_class
         ]
 
-    def retrieve(self, request, *args, **kwargs):
-        """
-        Disable this endpoint for singletons. They should use
-        the list endpoint instead.
-        """
-        if self.is_singleton:
-            raise MethodNotAllowed(
-                method="GET",
-                detail="Singleton objects do not support the retrieve endpoint.",
-            )
-
-        return super().retrieve(request, *args, **kwargs)
-
-    def update(self, request, *args, **kwargs):
-        """
-        We overwrite the update method to support singletons. If a singleton
-        doesn't exist it will be created.
-        """
-        if self.is_singleton:
-            try:
-                super().update(request, *args, **kwargs)
-            except NotFound:
-                self.create(request, *args, **kwargs)
-
-        return super().update(request, *args, **kwargs)
-
     def list(self, request, *args, **kwargs):
         """
         We overwrite the list method to support singletons. If a singleton
@@ -66,8 +40,8 @@ class BaseModelViewSet(ModelViewSet):
     def perform_create(self, serializer):
         instance = serializer.save()
 
-        if hasattr(instance, cs_settings.CREATED_BY):
-            setattr(instance, cs_settings.CREATED_BY, self.request.user)
+        if hasattr(instance, cs_settings.CREATED_BY_ATTR):
+            setattr(instance, cs_settings.CREATED_BY_ATTR, self.request.user)
             instance.save()
 
         content_type = ContentType.objects.get_for_model(instance)
@@ -83,8 +57,8 @@ class BaseModelViewSet(ModelViewSet):
     def perform_update(self, serializer):
         instance = serializer.save()
 
-        if hasattr(instance, cs_settings.EDITED_BY):
-            setattr(instance, cs_settings.EDITED_BY, self.request.user)
+        if hasattr(instance, cs_settings.EDITED_BY_ATTR):
+            setattr(instance, cs_settings.EDITED_BY_ATTR, self.request.user)
             instance.save()
 
         content_type = ContentType.objects.get_for_model(instance)
@@ -116,13 +90,11 @@ class BaseModelViewSet(ModelViewSet):
         If a singleton doesn't exist it will raise a NotFound exception.
         """
         if self.is_singleton:
-            try:
-                return self.get_queryset().get()
-            except self.queryset.model.DoesNotExist:
+            singleton = self.get_queryset().first()
+
+            if singleton:
+                return singleton
+            else:
                 raise NotFound()
 
         return super().get_object()
-
-    @property
-    def is_singleton(self):
-        return getattr(self.get_queryset().model, "is_singleton", False)

content_studio/widgets.py

@@ -1,30 +1,83 @@
-class InputWidget:
+###
+# Widgets determine what input field is used for a certain
+# model field. Each Django model field has a default widget,
+# but this can be overridden in the admin model.
+###
+
+
+class BaseWidget:
+    @classmethod
+    def serialize(cls):
+        return {"name": cls.__name__}
+
+
+class InputWidget(BaseWidget):
+    pass
+
+
+class TextAreaWidget(BaseWidget):
+    pass
+
+
+class SwitchWidget(BaseWidget):
+    pass
+
+
+class CheckboxWidget(BaseWidget):
+    pass
+
+
+class DateWidget(BaseWidget):
+    pass
+
+
+class DateTimeWidget(BaseWidget):
+    pass
+
+
+class TimeWidget(BaseWidget):
+    pass
+
+
+class RichTextWidget(BaseWidget):
+    pass
+
+
+class RadioButtonWidget(BaseWidget):
+    pass
+
+
+class SelectWidget(BaseWidget):
+    pass
+
+
+class MultiSelectWidget(BaseWidget):
     pass
 
 
-class TextAreaWidget:
+class URLPathWidget(BaseWidget):
     pass
 
 
-class BooleanWidget:
+class SlugWidget(BaseWidget):
     pass
 
 
-class TagWidget:
+class ForeignKeyWidget(BaseWidget):
     pass
 
 
-class RichTextWidget:
+class ManyToManyWidget(BaseWidget):
     pass
 
 
-class MultipleChoiceWidget:
+class JSONSchemaWidget(BaseWidget):
     pass
 
 
-class URLPathWidget:
+class JSONWidget(BaseWidget):
     pass
 
 
-class SlugWidget:
+class MediaWidget(BaseWidget):
     pass

{django_content_studio-1.0.0a1.dist-info → django_content_studio-1.0.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-content-studio
-Version: 1.0.0a1
+Version: 1.0.0b1
 Summary: Modern & flexible Django admin
 License: MIT
 Author: Leon van der Grient
@@ -23,8 +23,6 @@ Description-Content-Type: text/markdown
 
 Django Content Studio is a modern, flexible alternative to the Django admin.
 
-> This package is still under development
-
 ## 🚀 Quick Start
 
 ### Installation
@@ -63,8 +61,8 @@ urlpatterns = [
 
 ## 🐛 Issues & Support
 
-- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/StructuralRealist/django-content-studio/issues)
-- 💬 **Discussions**: [GitHub Discussions](https://github.com/StructuralRealist/django-content-studio/discussions)
+- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/BitsOfAbstraction/django-content-studio/issues)
+- 💬 **Discussions**: [GitHub Discussions](https://github.com/BitsOfAbstraction/django-content-studio/discussions)
 - 📧 **Email**: leon@devtastic.io
 
 ## 📄 License
@@ -80,7 +78,7 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ## 🔗 Links
 
 - [PyPI Package](https://pypi.org/project/django-content-studio/)
-- [GitHub Repository](https://github.com/StructuralRealist/django-content-studio)
+- [GitHub Repository](https://github.com/BitsOfAbstraction/django-content-studio)
 - [Changelog](CHANGELOG.md)
 
 ---

django_content_studio-1.0.0b1.dist-info/RECORD

@@ -0,0 +1,29 @@
+content_studio/__init__.py,sha256=-iiOBZCWYYqtuukOLDIAjBLRMgIZR5LlhNFYdjbRxMY,161
+content_studio/admin.py,sha256=cmTXKho64QrMMBoJtdMGMUpDjYORz3JjfutArFCAdyM,10017
+content_studio/apps.py,sha256=cfZvEixECgLN0g2zbu_Y94u5k3QBMyr_bgsgj4qYuoA,3503
+content_studio/dashboard/__init__.py,sha256=1GQcAuM5IlTlvqq6aPYA_QfuiEy_It0qx54VqDMQHCQ,1788
+content_studio/dashboard/activity_log.py,sha256=wTkDiHY4p2ijhcSJ0xPiSk5xxvFQUYjVoI1hKi7bdzE,813
+content_studio/filters.py,sha256=GyglR2E_wswomW7EnfShEXr14zxuRlLAuxrHVO3QQYg,4335
+content_studio/form.py,sha256=8yCas7l8Z3sLE6npo6JnTGyGCxez1v-PBIfbodVWOd0,2733
+content_studio/formats.py,sha256=JzOWrDRCVSnjJI0oX5fyFQU8LC634_jeAe84Widy43U,786
+content_studio/login_backends/__init__.py,sha256=hgPJh9hFobubImfhynaeZ_dku3sjqNQvN5B43TVg7Gw,643
+content_studio/login_backends/username_password.py,sha256=JJbF3oWnhOwLs-WaqclCCH6nAnrhlKbyBUzAJKVtq7A,2561
+content_studio/media_library/serializers.py,sha256=1MPFqbZdE0iTYqZrzzYoT_y4q0ItGTbQ-I7omyojAZo,660
+content_studio/media_library/viewsets.py,sha256=XsQuCrcfZ52xvvsEbHZ2WTI99wf-cheOKfaMJyfAJbo,4318
+content_studio/models.py,sha256=SLcgMIXu4FqwbQJBQ-jLw7_hlGjbSmwHmyKfzDsj-2M,2068
+content_studio/paginators.py,sha256=XrA6ECP2pO75SSj0Mi0Jqj7n_YPuIin-V8_6EOaQj64,589
+content_studio/router.py,sha256=7Up_sipGaUDoY6ElJNRf85ADaYfJCWV4To523L4LGuw,393
+content_studio/serializers.py,sha256=k5QLRiaa85jEiyljz2QdyTFcWY4gT8Lb28dBZsdEcsQ,3674
+content_studio/settings.py,sha256=6U0o-DxwpFQo-1LLumr3U4FCVTHiBzySK7M77HWvpf4,4510
+content_studio/templates/content_studio/index.html,sha256=lRSGmnyEHE_U1evO1O7K8nSGjmTgnR8z2OIZYmi2UwY,675
+content_studio/token_backends/__init__.py,sha256=dO3aWIHXX8He399ZEvlS4fNgyL84OY9TEtkva9b5N5Q,1183
+content_studio/token_backends/jwt.py,sha256=niGCpRqaUVhhS9haXfH1uFlg2v8NLB5IpsJ4N79Q0Gg,1565
+content_studio/urls.py,sha256=EY7lbzC0Q5vLfvqE3rK_4hmDrXhTuxKzYC55cc5tEEo,701
+content_studio/utils.py,sha256=xOolXd9Zmty6B6_2febvM8TmZhZ0JRc2nCLj3VooHkM,1488
+content_studio/views.py,sha256=GbANmQY_VyzQPD4Hw3MEfWF3pOr2G6a61Ktvu2Bw6d8,5370
+content_studio/viewsets.py,sha256=GrgtiK-HlrAfi4ubpLrBADszJMWxAupkBfIoS6OyIeA,3380
+content_studio/widgets.py,sha256=OlFKCAYNhkj2Ww9S_hvQTzUjcSnYXocmi04zusKrOTo,1071
+django_content_studio-1.0.0b1.dist-info/LICENSE,sha256=Wnx2EJhtSNnXE5Qs80i1HTBNFZTi8acEtC5TYqtFlnQ,1075
+django_content_studio-1.0.0b1.dist-info/METADATA,sha256=O7FLotNqu9ekxZ64SBrCYix43ohrFj1n3NgiiCMXt-c,2512
+django_content_studio-1.0.0b1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+django_content_studio-1.0.0b1.dist-info/RECORD,,

content_studio/dashboard.py

@@ -1,7 +0,0 @@
-class Dashboard:
-    """
-    The Dashboard class is used to define the structure of the dashboard
-    in Django Content Studio.
-    """
-
-    pass

django_content_studio-1.0.0a1.dist-info/RECORD

@@ -1,23 +0,0 @@
-content_studio/__init__.py,sha256=9XVz23GA6n6RDutB7K90md10AoDlSqDnilzAo1VCvhc,172
-content_studio/admin.py,sha256=H5gx6RKljSITL9UtE3yech97o2ZZhALgS9Mf0yWechA,4812
-content_studio/apps.py,sha256=OmOcBLnzUnP5T8oOd1iTrNNnrDRHUsX6WMQQV1IEc00,1880
-content_studio/dashboard.py,sha256=ptQ-cYp9ltsWeO3YK7Q_7WGgYwwzuM6zU0rxcuybjw4,146
-content_studio/form.py,sha256=-SZZ_OBCgn023GWMJEQqVdyZLA2hqDtDCdrqVLB4mNE,2006
-content_studio/login_backends/__init__.py,sha256=hgPJh9hFobubImfhynaeZ_dku3sjqNQvN5B43TVg7Gw,643
-content_studio/login_backends/username_password.py,sha256=QRkilK5E2S2o6xfK_jK64OdJ93Ima3lRYnvjncnVaH8,2441
-content_studio/models.py,sha256=Kk4Hw3T3impuWZ5Pfq1259KILq3wyqIBsXfA0MyuA3A,2613
-content_studio/router.py,sha256=7Up_sipGaUDoY6ElJNRf85ADaYfJCWV4To523L4LGuw,393
-content_studio/serializers.py,sha256=uOUXe7aDpgYN6B5rlZsN1_pFSPspV5exg3L7RxsTEhg,393
-content_studio/settings.py,sha256=wbwNN_RAk6Sv8hlB02dOveqUCzc-TVThau5rO47ANS0,4306
-content_studio/templates/content_studio/index.html,sha256=nzCbBJGhZijNYszIMB-NvCIqCP7KzDbpleKH1dVOw-c,729
-content_studio/token_backends/__init__.py,sha256=dO3aWIHXX8He399ZEvlS4fNgyL84OY9TEtkva9b5N5Q,1183
-content_studio/token_backends/jwt.py,sha256=Gd0IuhS6rjCzjTqkHWFMSpIt-x-07Jgr59moAVympBw,1667
-content_studio/urls.py,sha256=Rkb6QuyAGtn8MqkK7GmyVJXAq-q0mQT3CedhBSaCOr0,367
-content_studio/utils.py,sha256=8MibAxBgSZASZjPbPPpW9KplCUSHlM4TbUMkCNh5SDs,707
-content_studio/views.py,sha256=FR9CxuYJ-YiSVnxiFEwZlfpWfFSKv1hKtbUB6PC5qDE,2662
-content_studio/viewsets.py,sha256=sWbPRXm6UEkKUYPCjALZACWbixwI68BO_WB6Z2pj0Pg,4342
-content_studio/widgets.py,sha256=cBGvFrklzDkbwa39jhXc4Jp-kvykahpA01yk307VRXw,254
-django_content_studio-1.0.0a1.dist-info/LICENSE,sha256=Wnx2EJhtSNnXE5Qs80i1HTBNFZTi8acEtC5TYqtFlnQ,1075
-django_content_studio-1.0.0a1.dist-info/METADATA,sha256=GQq4ncwdxjf3FW2dW_jJUsaie0Lv0EVq0l2qhmNj8e4,2555
-django_content_studio-1.0.0a1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-django_content_studio-1.0.0a1.dist-info/RECORD,,