django-unfold 0.21.1__tar.gz → 0.23.0__tar.gz

{django_unfold-0.21.1 → django_unfold-0.23.0}/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Unfold Admin
+Copyright (c) 2023-present Unfold Admin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{django_unfold-0.21.1 → django_unfold-0.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-unfold
-Version: 0.21.1
+Version: 0.23.0
 Summary: Modern Django admin theme for seamless interface development
 Home-page: https://unfoldadmin.com
 License: MIT
@@ -59,6 +59,8 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Colors:** possibility to override default color scheme
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
+- **Parallel admin**: support for having default admin in parallel with Unfold
+- **VS Code**: project configuration and development container is included
 
 ## Table of contents <!-- omit from toc -->
 
@@ -94,6 +96,9 @@ Did you decide to start using Unfold but you don't have time to make the switch
   - [Pre-commit](#pre-commit)
   - [Poetry configuration](#poetry-configuration)
   - [Compiling Tailwind](#compiling-tailwind)
+  - [Using VS Code with containers](#using-vs-code-with-containers)
+    - [Development server](#development-server)
+    - [Compiling Tailwind in devcontainer](#compiling-tailwind-in-devcontainer)
 - [Credits](#credits)
 
 ## Installation
@@ -704,6 +709,10 @@ class CrontabScheduleAdmin(ModelAdmin):
 @admin.register(SolarSchedule)
 class SolarScheduleAdmin(ModelAdmin):
     pass
+
+@admin.register(ClockedSchedule)
+class ClockedScheduleAdmin(ModelAdmin):
+    pass
 ```
 
 ### django-guardian
@@ -733,7 +742,7 @@ When implementing `import_export.admin.ExportActionModelAdmin` class in admin pa
 admin.py
 
 from unfold.admin import ModelAdmin
-from unfold.contrib.import_export import ExportActionModelAdmin
+from unfold.contrib.import_export.admin import ExportActionModelAdmin
 
 class ExampleAdmin(ModelAdmin, ExportActionModelAdmin):
     pass
@@ -989,6 +998,7 @@ Before adding any source code, it is recommended to have pre-commit installed on
 pip install pre-commit
 pre-commit install
 pre-commit install --hook-type commit-msg
+pre-commit run --all-files # Check if everything is okay
 ```
 
 ### Poetry configuration
@@ -1016,6 +1026,20 @@ Some components like datepickers, calendars or selectors in admin was not possib
 
 **Note:** most of the custom styles located in style.css are created via `@apply some-tailwind-class;` as is not possible to manually add CSS class to element which are for example created via jQuery.
 
+### Using VS Code with containers
+
+Unfold already contains prepared support for VS Code development. After cloning the project locally, open the main folder in VS Code (in terminal `code .`). Immediately, you would see a message from VS Code **Folder contains a Dev Container configuration file. Reopen folder to develop in a container** which will inform you that the support for containers is prepared. Confirm the message by clicking on **Reopen in Container**. If the message is not there, you can still manually open the project in a container by running the command **Dev Containers: Reopen in Container**.
+
+#### Development server
+
+Now the VS Code will build an image and install Python dependencies. After successful installation is completed, VS Code will spin a container and from now it is possible to directly develop in the container. Unfold contains an example development application with the basic Unfold configuration available under `tests/server`. Run `python manage.py runserver` within a `tests/server` folder to start a development Django server. Note that you have to run the command from VS Code terminal which is already connected to the running container.
+
+**Note:** this is not a production ready server. Use it just for running tests or developing features & fixes.
+
+#### Compiling Tailwind in devcontainer
+
+The container has already a node preinstalled so it is possible to compile a new CSS. Open the terminal and run `npm install` which will install all dependencies and will create `node_modules` folder. Now, you can run npm commands for Tailwind as described in the previous chapter.
+
 ## Credits
 
 - [TailwindCSS](https://tailwindcss.com/) - CSS framework

{django_unfold-0.21.1 → django_unfold-0.23.0}/README.md

@@ -35,6 +35,8 @@ Did you decide to start using Unfold but you don't have time to make the switch
 - **Colors:** possibility to override default color scheme
 - **Third party packages:** default support for multiple popular applications
 - **Environment label**: distinguish between environments by displaying a label
+- **Parallel admin**: support for having default admin in parallel with Unfold
+- **VS Code**: project configuration and development container is included
 
 ## Table of contents <!-- omit from toc -->
 
@@ -70,6 +72,9 @@ Did you decide to start using Unfold but you don't have time to make the switch
   - [Pre-commit](#pre-commit)
   - [Poetry configuration](#poetry-configuration)
   - [Compiling Tailwind](#compiling-tailwind)
+  - [Using VS Code with containers](#using-vs-code-with-containers)
+    - [Development server](#development-server)
+    - [Compiling Tailwind in devcontainer](#compiling-tailwind-in-devcontainer)
 - [Credits](#credits)
 
 ## Installation
@@ -680,6 +685,10 @@ class CrontabScheduleAdmin(ModelAdmin):
 @admin.register(SolarSchedule)
 class SolarScheduleAdmin(ModelAdmin):
     pass
+
+@admin.register(ClockedSchedule)
+class ClockedScheduleAdmin(ModelAdmin):
+    pass
 ```
 
 ### django-guardian
@@ -709,7 +718,7 @@ When implementing `import_export.admin.ExportActionModelAdmin` class in admin pa
 admin.py
 
 from unfold.admin import ModelAdmin
-from unfold.contrib.import_export import ExportActionModelAdmin
+from unfold.contrib.import_export.admin import ExportActionModelAdmin
 
 class ExampleAdmin(ModelAdmin, ExportActionModelAdmin):
     pass
@@ -965,6 +974,7 @@ Before adding any source code, it is recommended to have pre-commit installed on
 pip install pre-commit
 pre-commit install
 pre-commit install --hook-type commit-msg
+pre-commit run --all-files # Check if everything is okay
 ```
 
 ### Poetry configuration
@@ -992,6 +1002,20 @@ Some components like datepickers, calendars or selectors in admin was not possib
 
 **Note:** most of the custom styles located in style.css are created via `@apply some-tailwind-class;` as is not possible to manually add CSS class to element which are for example created via jQuery.
 
+### Using VS Code with containers
+
+Unfold already contains prepared support for VS Code development. After cloning the project locally, open the main folder in VS Code (in terminal `code .`). Immediately, you would see a message from VS Code **Folder contains a Dev Container configuration file. Reopen folder to develop in a container** which will inform you that the support for containers is prepared. Confirm the message by clicking on **Reopen in Container**. If the message is not there, you can still manually open the project in a container by running the command **Dev Containers: Reopen in Container**.
+
+#### Development server
+
+Now the VS Code will build an image and install Python dependencies. After successful installation is completed, VS Code will spin a container and from now it is possible to directly develop in the container. Unfold contains an example development application with the basic Unfold configuration available under `tests/server`. Run `python manage.py runserver` within a `tests/server` folder to start a development Django server. Note that you have to run the command from VS Code terminal which is already connected to the running container.
+
+**Note:** this is not a production ready server. Use it just for running tests or developing features & fixes.
+
+#### Compiling Tailwind in devcontainer
+
+The container has already a node preinstalled so it is possible to compile a new CSS. Open the terminal and run `npm install` which will install all dependencies and will create `node_modules` folder. Now, you can run npm commands for Tailwind as described in the previous chapter.
+
 ## Credits
 
 - [TailwindCSS](https://tailwindcss.com/) - CSS framework

{django_unfold-0.21.1 → django_unfold-0.23.0}/pyproject.toml

@@ -1,21 +1,14 @@
 [tool.poetry]
 name = "django-unfold"
-version = "0.21.1"
+version = "0.23.0"
 description = "Modern Django admin theme for seamless interface development"
 license = "MIT"
 readme = "README.md"
 authors = []
 homepage = "https://unfoldadmin.com"
 repository = "https://github.com/unfoldadmin/django-unfold"
-packages = [
-    { include = "unfold", from = "src" },
-]
-keywords = [
-    "django",
-    "admin",
-    "tailwind",
-    "theme",
-]
+packages = [{ include = "unfold", from = "src" }]
+keywords = ["django", "admin", "tailwind", "theme"]
 classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.8",
@@ -39,13 +32,14 @@ pytest-django = "^4.5.2"
 tox = "^4.5.2"
 
 
-
 [tool.poetry.group.dev.dependencies]
 python-semantic-release = "^8.7.0"
 
 [tool.ruff]
 fix = true
 line-length = 88
+
+[tool.ruff.lint]
 select = [
     "E",  # pycodestyle errors
     "W",  # pycodestyle warnings
@@ -56,23 +50,19 @@ select = [
     "UP", # pyupgrade
 ]
 ignore = [
-    "E501",  # line too long, handled by black
-    "B905",  # zip() without strict=True
-    "C901",  # too complex
+    "E501", # line too long, handled by black
+    "B905", # zip() without strict=True
+    "C901", # too complex
 ]
 
 [tool.semantic_release]
 tag_format = "{version}"
 major_on_zero = true
-version_toml = [
-    "pyproject.toml:tool.poetry.version"
-]
+version_toml = ["pyproject.toml:tool.poetry.version"]
 
 [tool.semantic_release.changelog]
 template_dir = ".github/templates"
-exclude_commit_patterns = [
-    "chore: version bump"
-]
+exclude_commit_patterns = ["chore: version bump"]
 
 [tool.semantic_release.changelog.environment]
 trim_blocks = true
@@ -85,8 +75,9 @@ upload_to_vcs_release = false
 addopts = """\
     --strict-config
     --strict-markers
-    --ds=tests.settings
+    --ds=example.settings
     """
+pythonpath = "tests/server"
 django_find_project = false
 
 [build-system]

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/admin.py

@@ -8,6 +8,7 @@ from django.contrib.admin import StackedInline as BaseStackedInline
 from django.contrib.admin import TabularInline as BaseTabularInline
 from django.contrib.admin import display, helpers
 from django.contrib.admin.utils import lookup_field
+from django.contrib.admin.widgets import RelatedFieldWidgetWrapper
 from django.core.exceptions import ObjectDoesNotExist
 from django.db import models
 from django.db.models import (
@@ -39,7 +40,6 @@ from django.utils.safestring import SafeText, mark_safe
 from django.utils.text import capfirst
 from django.utils.translation import gettext_lazy as _
 from django.views import View
-from unfold.utils import display_for_field
 
 from .checks import UnfoldModelAdminChecks
 from .dataclasses import UnfoldAction
@@ -47,9 +47,9 @@ from .exceptions import UnfoldException
 from .forms import ActionForm
 from .settings import get_config
 from .typing import FieldsetsType
+from .utils import display_for_field
 from .widgets import (
     CHECKBOX_LABEL_CLASSES,
-    INPUT_CLASSES,
     LABEL_CLASSES,
     SELECT_CLASSES,
     UnfoldAdminBigIntegerFieldWidget,
@@ -62,6 +62,7 @@ from .widgets import (
     UnfoldAdminMoneyWidget,
     UnfoldAdminNullBooleanSelectWidget,
     UnfoldAdminRadioSelectWidget,
+    UnfoldAdminSelect,
     UnfoldAdminSingleDateWidget,
     UnfoldAdminSingleTimeWidget,
     UnfoldAdminSplitDateTimeWidget,
@@ -142,6 +143,11 @@ class UnfoldAdminField(helpers.AdminField):
     def label_tag(self) -> SafeText:
         classes = []
 
+        if not self.field.field.widget.__class__.__name__.startswith(
+            "Unfold"
+        ) and not self.field.field.widget.template_name.startswith("unfold"):
+            return super().label_tag()
+
         # TODO load config from current AdminSite (override Fieldline.__iter__ method)
         for lang, flag in get_config()["EXTENSIONS"]["modeltranslation"][
             "flags"
@@ -175,6 +181,9 @@ helpers.AdminField = UnfoldAdminField
 
 class UnfoldAdminReadonlyField(helpers.AdminReadonlyField):
     def label_tag(self) -> SafeText:
+        if not isinstance(self.model_admin, ModelAdmin):
+            return super().label_tag()
+
         attrs = {
             "class": " ".join(LABEL_CLASSES + ["mb-2"]),
         }
@@ -285,9 +294,7 @@ class ModelAdminMixin:
                     radio_style=self.radio_fields[db_field.name]
                 )
             else:
-                kwargs["widget"] = forms.Select(
-                    attrs={"class": " ".join(SELECT_CLASSES)}
-                )
+                kwargs["widget"] = UnfoldAdminSelect()
 
             kwargs["choices"] = db_field.get_choices(
                 include_blank=db_field.blank, blank_choice=[("", _("Select value"))]
@@ -301,16 +308,12 @@ class ModelAdminMixin:
         # Overrides widgets for all related fields
         if "widget" not in kwargs:
             if db_field.name in self.raw_id_fields:
-                kwargs["widget"] = forms.TextInput(
-                    attrs={"class": " ".join(INPUT_CLASSES)}
-                )
+                kwargs["widget"] = UnfoldAdminTextInputWidget()
             elif (
                 db_field.name not in self.get_autocomplete_fields(request)
                 and db_field.name not in self.radio_fields
             ):
-                kwargs["widget"] = forms.Select(
-                    attrs={"class": " ".join(SELECT_CLASSES)}
-                )
+                kwargs["widget"] = UnfoldAdminSelect()
                 kwargs["empty_label"] = _("Select value")
 
         return super().formfield_for_foreignkey(db_field, request, **kwargs)
@@ -323,9 +326,7 @@ class ModelAdminMixin:
     ) -> ModelMultipleChoiceField:
         if "widget" not in kwargs:
             if db_field.name in self.raw_id_fields:
-                kwargs["widget"] = forms.TextInput(
-                    attrs={"class": " ".join(INPUT_CLASSES)}
-                )
+                kwargs["widget"] = UnfoldAdminTextInputWidget()
 
         form_field = super().formfield_for_manytomany(db_field, request, **kwargs)
 
@@ -342,9 +343,7 @@ class ModelAdminMixin:
         self, db_field: Field, request: HttpRequest, **kwargs
     ) -> Optional[Field]:
         if "widget" not in kwargs:
-            kwargs["widget"] = forms.NullBooleanSelect(
-                attrs={"class": " ".join(SELECT_CLASSES)}
-            )
+            kwargs["widget"] = UnfoldAdminNullBooleanSelectWidget()
 
         return db_field.formfield(**kwargs)
 
@@ -354,7 +353,14 @@ class ModelAdminMixin:
         if isinstance(db_field, models.BooleanField) and db_field.null is True:
             return self.formfield_for_nullboolean_field(db_field, request, **kwargs)
 
-        return super().formfield_for_dbfield(db_field, request, **kwargs)
+        formfield = super().formfield_for_dbfield(db_field, request, **kwargs)
+
+        if formfield and isinstance(formfield.widget, RelatedFieldWidgetWrapper):
+            formfield.widget.template_name = (
+                "unfold/widgets/related_widget_wrapper.html"
+            )
+
+        return formfield
 
 
 class ModelAdmin(ModelAdminMixin, BaseModelAdmin):
@@ -400,7 +406,7 @@ class ModelAdmin(ModelAdminMixin, BaseModelAdmin):
                 filtered_actions.append(action)
                 continue
             permission_checks = (
-                getattr(self, "has_%s_permission" % permission)
+                getattr(self, f"has_{permission}_permission")
                 for permission in action.method.allowed_permissions
             )
             if any(has_permission(request) for has_permission in permission_checks):
@@ -546,7 +552,8 @@ class ModelAdmin(ModelAdminMixin, BaseModelAdmin):
                         "title": action.description,
                         "attrs": action.method.attrs,
                         "path": reverse(
-                            f"admin:{action.action_name}", args=(object_id,)
+                            f"{self.admin_site.name}:{action.action_name}",
+                            args=(object_id,),
                         ),
                     }
                 )
@@ -570,7 +577,7 @@ class ModelAdmin(ModelAdminMixin, BaseModelAdmin):
             {
                 "title": action.description,
                 "attrs": action.method.attrs,
-                "path": reverse(f"admin:{action.action_name}"),
+                "path": reverse(f"{self.admin_site.name}:{action.action_name}"),
             }
             for action in self.get_actions_list(request)
         ]
@@ -579,7 +586,7 @@ class ModelAdmin(ModelAdminMixin, BaseModelAdmin):
             {
                 "title": action.description,
                 "attrs": action.method.attrs,
-                "raw_path": f"admin:{action.action_name}",
+                "raw_path": f"{self.admin_site.name}:{action.action_name}",
             }
             for action in self.get_actions_row(request)
         ]

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/apps.py

@@ -7,9 +7,14 @@ from .sites import UnfoldAdminSite
 
 class DefaultAppConfig(AppConfig):
     name = "unfold"
+    default = True
 
     def ready(self):
         site = UnfoldAdminSite()
 
         admin.site = site
         sites.site = site
+
+
+class BasicAppConfig(AppConfig):
+    name = "unfold"

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/checks.py

@@ -30,7 +30,7 @@ class UnfoldModelAdminChecks(ModelAdminChecks):
             if not hasattr(action.method, "allowed_permissions"):
                 continue
             for permission in action.method.allowed_permissions:
-                method_name = "has_%s_permission" % permission
+                method_name = f"has_{permission}_permission"
                 if not hasattr(obj, method_name):
                     errors.append(
                         checks.Error(

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/contrib/filters/apps.py

@@ -3,3 +3,4 @@ from django.apps import AppConfig
 
 class DefaultAppConfig(AppConfig):
     name = "unfold.contrib.filters"
+    label = "unfold_filters"

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/contrib/forms/apps.py

@@ -3,3 +3,4 @@ from django.apps import AppConfig
 
 class DefaultAppConfig(AppConfig):
     name = "unfold.contrib.forms"
+    label = "unfold_forms"

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/contrib/guardian/apps.py

@@ -3,4 +3,4 @@ from django.apps import AppConfig
 
 class GuardianConfig(AppConfig):
     name = "unfold.contrib.guardian"
-    label = "unfoldguardian"
+    label = "unfold_guardian"

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/contrib/import_export/apps.py

@@ -3,4 +3,4 @@ from django.apps import AppConfig
 
 class ImportExportConfig(AppConfig):
     name = "unfold.contrib.import_export"
-    label = "importexport"
+    label = "unfold_importexport"

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/forms.py

@@ -22,7 +22,12 @@ from .widgets import BASE_INPUT_CLASSES, INPUT_CLASSES, SELECT_CLASSES
 class ActionForm(forms.Form):
     action = forms.ChoiceField(
         label="",
-        widget=forms.Select({"class": " ".join([*SELECT_CLASSES, "w-72"])}),
+        widget=forms.Select(
+            {
+                "class": " ".join([*SELECT_CLASSES, "max-w-full", "lg:!w-64"]),
+                "x-model": "action",
+            }
+        ),
     )
 
     select_across = forms.BooleanField(

{django_unfold-0.21.1 → django_unfold-0.23.0}/src/unfold/sites.py

@@ -205,7 +205,7 @@ class UnfoldAdminSite(AdminSite):
 
         from .forms import AdminOwnPasswordChangeForm
 
-        url = reverse("admin:password_change_done", current_app=self.name)
+        url = reverse(f"{self.name}:password_change_done", current_app=self.name)
         defaults = {
             "form_class": AdminOwnPasswordChangeForm,
             "success_url": url,
@@ -224,9 +224,9 @@ class UnfoldAdminSite(AdminSite):
             if not isinstance(link, str):
                 link = str(link)
 
-            if link in request.path and link != reverse_lazy("admin:index"):
+            if link in request.path and link != reverse_lazy(f"{self.name}:index"):
                 return True
-            elif link == request.path == reverse_lazy("admin:index"):
+            elif link == request.path == reverse_lazy(f"{self.name}:index"):
                 return True
 
             return False
@@ -266,7 +266,7 @@ class UnfoldAdminSite(AdminSite):
                 if "badge" in item and isinstance(item["badge"], str):
                     try:
                         callback = import_string(item["badge"])
-                        item["badge"] = lazy(callback)(request)
+                        item["badge_callback"] = lazy(callback)(request)
                     except ImportError:
                         pass