django-smartbase-admin 0.2.100__tar.gz → 1.0.0__tar.gz

django_smartbase_admin-1.0.0/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.1
+Name: django-smartbase-admin
+Version: 1.0.0
+Summary: 
+Author: SmartBase
+Author-email: info@smartbase.sk
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: django (>=4.1,<6.0)
+Requires-Dist: django-admin-inline-paginator (>=0.4.0,<0.5.0)
+Requires-Dist: django-ckeditor (>=6.7.1,<7.0.0)
+Requires-Dist: django-filer (>=3.1.1,<4.0.0)
+Requires-Dist: django-htmx (>=1.17.3,<2.0.0)
+Requires-Dist: django-nested-admin (>=4.0.2,<5.0.0)
+Requires-Dist: django-widget-tweaks (>=1.5.0,<2.0.0)
+Requires-Dist: easy-thumbnails[svg] (>=2.8.5,<3.0.0)
+Requires-Dist: setuptools (>=67.0.0,<68.0.0)
+Requires-Dist: xlsxwriter (>=3.2.0,<4.0.0)
+Description-Content-Type: text/markdown
+
+# Django SmartBase Admin
+
+A modern, modular, and developer-friendly admin interface for Django.  
+Built to **speed up development** of internal tools and admin panels — beautifully and efficiently.
+
+---
+
+## ✨ Features
+- Fast integration with any Django project
+- Improved performance of Django List Admin using `SBAdminField`, database `annotate()` and `values()` to avoid direct object access  
+- Simple configuration of menu structure, dashboard components, and permissions per user role  
+- Enhanced Django List Admin filters: autocomplete support for related fields and filtering across all model fields  
+- Ability for users to save and reuse custom filters in Django List Admin  
+- Improved Django Detail Admin with autocomplete for relational fields  
+- Support for "FakeInlines" – define inline-like blocks without requiring a direct model relationship  
+- Easy extension of list and detail views with custom actions and corresponding views
+- Beautiful modern UI (Tailwind CSS)
+- Responsive & mobile-friendly
+
+![image](https://github.com/user-attachments/assets/b99a35b0-05fd-45e3-a165-950b0d4750cd)
+![image](https://github.com/user-attachments/assets/f7719377-eb88-42c4-8fe0-5d4ca0ff29bf)
+
+
+## 📚 Full Documentation (in progress)
+
+🗂 [View Full Docs](https://smartbase-sk.github.io/django-smartbase-admin-docs/docs/installation)
+
+## ⚡ Quick Start
+
+### 1. Install Smartbase Admin
+
+Begin by installing the Smartbase Admin package using `pip`:
+
+```bash
+pip install django-smartbase-admin
+```
+
+Ensure that django-smartbase-admin and its dependencies are included in your Django settings. Open your `settings.py` file and add the following to `INSTALLED_APPS`:
+```python
+INSTALLED_APPS = [
+    # other apps
+    "django_smartbase_admin",
+    "easy_thumbnails",
+    "widget_tweaks",
+]
+```
+
+### 2. Add Admin URL Configuration
+In your project’s `urls.py`, register the Smartbase Admin site by importing sb_admin_site and adding the path:
+```python
+from django_smartbase_admin.admin.site import sb_admin_site
+
+urlpatterns = [
+    path("sb-admin/", sb_admin_site.urls),
+    # other paths
+]
+```
+This makes the Smartbase Admin interface accessible at `/sb-admin/`
+
+### 3. Define the SmartBase Admin Configuration
+In your project, for example in `config` package create a file called `sbadmin_config.py` with the following content:
+```python
+from django_smartbase_admin.engine.configuration import SBAdminConfigurationBase, SBAdminRoleConfiguration
+from django_smartbase_admin.views.dashboard_view import SBAdminDashboardView
+from django_smartbase_admin.engine.menu_item import SBAdminMenuItem
+
+config = SBAdminRoleConfiguration(
+    default_view=SBAdminMenuItem(view_id="dashboard"),
+    menu_items=[
+        SBAdminMenuItem(view_id="dashboard", icon="All-application"),
+    ],
+    registered_views=[
+        SBAdminDashboardView(widgets=[], title="Dashboard"),
+    ],
+)
+
+class SBAdminConfiguration(SBAdminConfigurationBase):
+    def get_configuration_for_roles(self, user_roles):
+        return config
+```
+
+### 4. Reference the Configuration in `settings.py`
+```python
+SB_ADMIN_CONFIGURATION = "config.sbadmin_config.SBAdminConfiguration"
+```
+
+### 5. Add Locale Middleware
+Add the following middleware to support internationalization:
+```python
+MIDDLEWARE = [
+    # Other middleware...
+    'django.middleware.locale.LocaleMiddleware',
+]
+```
+
+##  🤝 Need Help with Development?
+We at SmartBase are experts in Django and custom software.
+
+Whether you're building a new platform or modernizing an internal tool —
+💡 We can help you design, build, and scale it.
+
+📬 [Let’s talk](https://en.smartbase.sk/contact-us/) — We’d love to work with you.
+

django_smartbase_admin-1.0.0/README.md

@@ -0,0 +1,102 @@
+# Django SmartBase Admin
+
+A modern, modular, and developer-friendly admin interface for Django.  
+Built to **speed up development** of internal tools and admin panels — beautifully and efficiently.
+
+---
+
+## ✨ Features
+- Fast integration with any Django project
+- Improved performance of Django List Admin using `SBAdminField`, database `annotate()` and `values()` to avoid direct object access  
+- Simple configuration of menu structure, dashboard components, and permissions per user role  
+- Enhanced Django List Admin filters: autocomplete support for related fields and filtering across all model fields  
+- Ability for users to save and reuse custom filters in Django List Admin  
+- Improved Django Detail Admin with autocomplete for relational fields  
+- Support for "FakeInlines" – define inline-like blocks without requiring a direct model relationship  
+- Easy extension of list and detail views with custom actions and corresponding views
+- Beautiful modern UI (Tailwind CSS)
+- Responsive & mobile-friendly
+
+![image](https://github.com/user-attachments/assets/b99a35b0-05fd-45e3-a165-950b0d4750cd)
+![image](https://github.com/user-attachments/assets/f7719377-eb88-42c4-8fe0-5d4ca0ff29bf)
+
+
+## 📚 Full Documentation (in progress)
+
+🗂 [View Full Docs](https://smartbase-sk.github.io/django-smartbase-admin-docs/docs/installation)
+
+## ⚡ Quick Start
+
+### 1. Install Smartbase Admin
+
+Begin by installing the Smartbase Admin package using `pip`:
+
+```bash
+pip install django-smartbase-admin
+```
+
+Ensure that django-smartbase-admin and its dependencies are included in your Django settings. Open your `settings.py` file and add the following to `INSTALLED_APPS`:
+```python
+INSTALLED_APPS = [
+    # other apps
+    "django_smartbase_admin",
+    "easy_thumbnails",
+    "widget_tweaks",
+]
+```
+
+### 2. Add Admin URL Configuration
+In your project’s `urls.py`, register the Smartbase Admin site by importing sb_admin_site and adding the path:
+```python
+from django_smartbase_admin.admin.site import sb_admin_site
+
+urlpatterns = [
+    path("sb-admin/", sb_admin_site.urls),
+    # other paths
+]
+```
+This makes the Smartbase Admin interface accessible at `/sb-admin/`
+
+### 3. Define the SmartBase Admin Configuration
+In your project, for example in `config` package create a file called `sbadmin_config.py` with the following content:
+```python
+from django_smartbase_admin.engine.configuration import SBAdminConfigurationBase, SBAdminRoleConfiguration
+from django_smartbase_admin.views.dashboard_view import SBAdminDashboardView
+from django_smartbase_admin.engine.menu_item import SBAdminMenuItem
+
+config = SBAdminRoleConfiguration(
+    default_view=SBAdminMenuItem(view_id="dashboard"),
+    menu_items=[
+        SBAdminMenuItem(view_id="dashboard", icon="All-application"),
+    ],
+    registered_views=[
+        SBAdminDashboardView(widgets=[], title="Dashboard"),
+    ],
+)
+
+class SBAdminConfiguration(SBAdminConfigurationBase):
+    def get_configuration_for_roles(self, user_roles):
+        return config
+```
+
+### 4. Reference the Configuration in `settings.py`
+```python
+SB_ADMIN_CONFIGURATION = "config.sbadmin_config.SBAdminConfiguration"
+```
+
+### 5. Add Locale Middleware
+Add the following middleware to support internationalization:
+```python
+MIDDLEWARE = [
+    # Other middleware...
+    'django.middleware.locale.LocaleMiddleware',
+]
+```
+
+##  🤝 Need Help with Development?
+We at SmartBase are experts in Django and custom software.
+
+Whether you're building a new platform or modernizing an internal tool —
+💡 We can help you design, build, and scale it.
+
+📬 [Let’s talk](https://en.smartbase.sk/contact-us/) — We’d love to work with you.

{django_smartbase_admin-0.2.100 → django_smartbase_admin-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "django-smartbase-admin"
-version = "0.2.100"
+version = "1.0.0"
 description = ""
 authors = ["SmartBase <info@smartbase.sk>"]
 readme = "README.md"

{django_smartbase_admin-0.2.100 → django_smartbase_admin-1.0.0}/src/django_smartbase_admin/actions/admin_action_list.py

@@ -4,6 +4,8 @@ import math
 from django.core.paginator import Paginator
 from django.db.models import Q
 from django.utils import timezone
+from django.utils.html import escape
+from django.utils.safestring import SafeString
 from django.utils.text import smart_split, unescape_string_literal
 
 from django_smartbase_admin.engine.const import (
@@ -406,11 +408,11 @@ class SBAdminListAction(SBAdminAction):
 
     def process_final_data(self, final_data):
         visible_columns = self.get_visible_column_fields()
-        fields_with_methods_to_call = [
-            field
+        fields_with_methods_to_call_by_field_key = {
+            field.field: field
             for field in visible_columns
             if field.view_method or field.python_formatter
-        ]
+        }
         for row in final_data:
             additional_data = {}
             if self.view.sbadmin_list_display_data:
@@ -418,18 +420,23 @@ class SBAdminListAction(SBAdminAction):
                     data: row.get(data, None)
                     for data in self.view.sbadmin_list_display_data
                 }
-            for field in fields_with_methods_to_call:
-                object_id = row.get(self.get_pk_field().name, None)
-                value = row.get(field.field, None)
-                processed_value = value
-                if field.view_method:
-                    processed_value = field.view_method(
-                        object_id, value, **additional_data
-                    )
-                formatted_value = processed_value
-                if field.python_formatter:
-                    formatted_value = field.python_formatter(object_id, processed_value)
-                row[field.field] = formatted_value
+            for field_key, value in row.items():
+                if field_key in fields_with_methods_to_call_by_field_key:
+                    field = fields_with_methods_to_call_by_field_key[field_key]
+                    object_id = row.get(self.get_pk_field().name, None)
+                    processed_value = value
+                    if field.view_method:
+                        processed_value = field.view_method(
+                            object_id, value, **additional_data
+                        )
+                    formatted_value = processed_value
+                    if field.python_formatter:
+                        formatted_value = field.python_formatter(
+                            object_id, processed_value
+                        )
+                    row[field_key] = formatted_value
+                if isinstance(value, str) and not isinstance(value, SafeString):
+                    row[field_key] = escape(value)
 
     def get_json_data(self):
         return self.get_data()

{django_smartbase_admin-0.2.100 → django_smartbase_admin-1.0.0}/src/django_smartbase_admin/admin/admin_base.py

@@ -215,11 +215,16 @@ class SBAdminFormFieldWidgetsMixin:
         )  # remove origin classes to prevent override our custom widget class
         kwargs = {}
         if isinstance(form_field, RichTextFormField):
-            kwargs["config_name"] = getattr(db_field, "config_name", "default")
+            kwargs["config_name"] = getattr(
+                form_field.widget, "config_name", None
+            ) or getattr(db_field, "config_name", "default")
+
             kwargs["external_plugin_resources"] = getattr(
-                db_field, "external_plugin_resources", []
-            )
-            kwargs["extra_plugins"] = getattr(db_field, "extra_plugins", [])
+                form_field.widget, "external_plugin_resources", None
+            ) or getattr(db_field, "external_plugin_resources", [])
+            kwargs["extra_plugins"] = getattr(
+                form_field.widget, "extra_plugins", None
+            ) or getattr(db_field, "extra_plugins", [])
         form_field.widget = widget(form_field=form_field, attrs=widget_attrs, **kwargs)
         return form_field
 

{django_smartbase_admin-0.2.100 → django_smartbase_admin-1.0.0}/src/django_smartbase_admin/engine/field.py

@@ -100,7 +100,7 @@ class SBAdminField(JSONSerializableMixin):
         list_visible=None,
         list_collapsed=None,
         auto_created=None,
-        formatter: Formatter = None,
+        formatter: Formatter = Formatter.HTML.value,
         tabulator_editor=None,
         python_formatter=None,
         tabulator_options: "TabulatorFieldOptions" = None,
@@ -185,7 +185,6 @@ class SBAdminField(JSONSerializableMixin):
             if self.model_field and not self.annotate:
                 self.annotate = F(field_name)
             self.filter_field = self.filter_field or field_name
-            self.formatter = "html"
         if self.view.model and not self.model_field:
             self.model_field = self.get_model_field_from_model(self.name)
         if (
@@ -225,8 +224,6 @@ class SBAdminField(JSONSerializableMixin):
                 self.python_formatter = datetime_formatter
             if isinstance(self.model_field, BooleanField):
                 self.python_formatter = boolean_formatter
-        if self.python_formatter and not self.formatter:
-            self.formatter = "html"
         self.filter_field = self.filter_field or self.field
         self.init_filter_for_field(configuration)
         self.initialized = True

{django_smartbase_admin-0.2.100 → django_smartbase_admin-1.0.0}/src/django_smartbase_admin/engine/field_formatter.py

@@ -1,6 +1,7 @@
 from enum import Enum
 
 from django.template.defaultfilters import date, time
+from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 from django.utils import timezone
 
@@ -38,8 +39,10 @@ def datetime_formatter_with_format(date_format=None, time_format=None):
 
 def boolean_formatter(object_id, value):
     if value:
-        return f'<span class="badge badge-simple badge-positive">{_("Yes")}</span>'
-    return f'<span class="badge badge-simple badge-neutral">{_("No")}</span>'
+        return mark_safe(
+            f'<span class="badge badge-simple badge-positive">{_("Yes")}</span>'
+        )
+    return mark_safe(f'<span class="badge badge-simple badge-neutral">{_("No")}</span>')
 
 
 def format_array(value_list, separator="", badge_type: BadgeType = BadgeType.NOTICE):
@@ -50,7 +53,7 @@ def format_array(value_list, separator="", badge_type: BadgeType = BadgeType.NOT
         if not value:
             continue
         result += f'<span class="badge badge-simple badge-{badge_type.value} mr-4">{value}</span>{separator}'
-    return result
+    return mark_safe(result)
 
 
 def array_badge_formatter(object_id, value_list):
@@ -62,8 +65,10 @@ def newline_separated_array_badge_formatter(object_id, value_list):
 
 
 def rich_text_formatter(object_id, value):
-    return f'<div style="max-width: 500px; white-space: normal;">{value}</div>'
+    return mark_safe(
+        f'<div style="max-width: 500px; white-space: normal;">{value}</div>'
+    )
 
 
 def link_formatter(object_id, value):
-    return f'<a href="{value}">{value}</a>'
+    return mark_safe(f'<a href="{value}">{value}</a>')