django-eadmin 0.1.0__tar.gz

django_eadmin-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include eadmin/templates *.html
+recursive-include eadmin/static *
+include eadmin/py.typed
+include README-eadmin.md

django_eadmin-0.1.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: django-eadmin
+Version: 0.1.0
+Summary: A reusable Tailwind, HTMX, Alpine.js, and DaisyUI Django administration app.
+Author: EAdmin contributors
+License-Expression: LicenseRef-Proprietary
+Project-URL: Documentation, https://github.com/django-cms/django-cms
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Django<5.3,>=5.1
+
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration app built
+with Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It provides a separate
+`/eadmin/` workspace and does not replace Django's built-in `/admin/` site.
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Put `eadmin` before applications that register models so its templates and
+static assets are discovered first:
+
+```python
+INSTALLED_APPS = [
+    "eadmin.apps.EAdminConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    # …remaining Django and project apps
+]
+
+TEMPLATES[0]["OPTIONS"]["context_processors"] += [
+    "eadmin.context_processors.navigation",
+]
+```
+
+Mount its URLs separately from the native admin:
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    path("eadmin/", include("eadmin.urls")),
+    path("admin/", admin.site.urls),
+]
+```
+
+## Register models
+
+Create an `eadmin.py` in any installed Django app:
+
+```python
+from eadmin.registry import ModelAdmin, site
+from .models import Article
+
+site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+EAdmin discovers these registrations through the installed app configuration.
+It applies Django model permissions to every page and action. By default,
+one-to-one and foreign-key fields use a single select; many-to-many fields use
+a multi-select dropdown. Registrations can opt into autocomplete, raw-ID, or
+transfer controls for exceptional relationships.
+
+## Development install
+
+From a checkout containing this package:
+
+```bash
+python -m pip install -e .
+```

django_eadmin-0.1.0/README-eadmin.md

@@ -0,0 +1,68 @@
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration app built
+with Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It provides a separate
+`/eadmin/` workspace and does not replace Django's built-in `/admin/` site.
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Put `eadmin` before applications that register models so its templates and
+static assets are discovered first:
+
+```python
+INSTALLED_APPS = [
+    "eadmin.apps.EAdminConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    # …remaining Django and project apps
+]
+
+TEMPLATES[0]["OPTIONS"]["context_processors"] += [
+    "eadmin.context_processors.navigation",
+]
+```
+
+Mount its URLs separately from the native admin:
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    path("eadmin/", include("eadmin.urls")),
+    path("admin/", admin.site.urls),
+]
+```
+
+## Register models
+
+Create an `eadmin.py` in any installed Django app:
+
+```python
+from eadmin.registry import ModelAdmin, site
+from .models import Article
+
+site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+EAdmin discovers these registrations through the installed app configuration.
+It applies Django model permissions to every page and action. By default,
+one-to-one and foreign-key fields use a single select; many-to-many fields use
+a multi-select dropdown. Registrations can opt into autocomplete, raw-ID, or
+transfer controls for exceptional relationships.
+
+## Development install
+
+From a checkout containing this package:
+
+```bash
+python -m pip install -e .
+```

django_eadmin-0.1.0/README.md

@@ -0,0 +1,189 @@
+# Django CMS
+
+一个前后端不分离的通用 Django CMS：前台使用 Django Template + HTMX，管理端使用 Tailwind CSS、DaisyUI、HTMX、Alpine.js；缓存及会话使用 Redis。
+
+## 运行环境
+
+- Python 3.12+
+- SQLite 3.35+、PostgreSQL 14+ 或 MySQL 8+
+- Redis 6+
+
+## 本地启动
+
+### 1. 准备数据库与 Redis
+
+SQLite 不需要单独启动服务；PostgreSQL 或 MySQL 请先创建数据库及账户。Redis 用于缓存与会话。
+
+```sql
+CREATE USER djangocms WITH PASSWORD 'djangocms';
+CREATE DATABASE djangocms OWNER djangocms;
+```
+
+可选数据库连接：
+
+```text
+SQLite:     sqlite:///db.sqlite3
+PostgreSQL: postgresql://djangocms:djangocms@127.0.0.1:5432/djangocms
+MySQL:      mysql://djangocms:djangocms@127.0.0.1:3306/djangocms
+Redis:      redis://127.0.0.1:6379/1（无密码）
+```
+
+### 2. 创建 Python 虚拟环境并安装依赖
+
+在项目根目录执行：
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip install -r requirements.txt
+```
+
+Windows PowerShell 请改用：
+
+```powershell
+.venv\Scripts\Activate.ps1
+```
+
+### 3. 配置环境变量
+
+复制示例配置：
+
+```bash
+cp .env.example .env
+```
+
+开发环境启动时会自动加载根目录 `.env`。请检查以下配置：
+
+```dotenv
+DJANGO_SECRET_KEY=请替换为本地随机密钥
+DJANGO_DEBUG=true
+DJANGO_VALIDATE_SERVICES_ON_STARTUP=true
+DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1
+# 首选显式驱动：sqlite / postgresql / mysql
+DATABASE_ENGINE=sqlite
+DATABASE_NAME=db.sqlite3
+# PostgreSQL / MySQL 使用以下分项：
+# DATABASE_ENGINE=postgresql
+# DATABASE_NAME=djangocms
+# DATABASE_USER=djangocms
+# DATABASE_PASSWORD=djangocms
+# DATABASE_HOST=127.0.0.1
+# DATABASE_PORT=5432
+# MySQL 可设置 DATABASE_CHARSET=utf8mb4
+# 兼容模式：不设置 DATABASE_ENGINE 时可使用 DATABASE_URL
+# DATABASE_URL=postgresql://djangocms:djangocms@127.0.0.1:5432/djangocms
+# Redis 无密码时：
+REDIS_URL=redis://127.0.0.1:6379/1
+# Redis 有密码时：
+# REDIS_URL=redis://:你的Redis密码@127.0.0.1:6379/1
+CMS_THEME=default
+SITE_NAME=Django CMS
+TIME_ZONE=Asia/Shanghai
+```
+
+`.env` 已被 Git 忽略，不应提交真实密码或生产密钥。生产环境请在部署平台设置同名环境变量。
+
+Redis 密码写在 URL 的 `:` 与 `@` 之间；无密码时可使用 `redis://127.0.0.1:6379/1`。如果密码含有 `@`、`:`、`/`、`#`、`?`、`%` 等特殊字符，必须先进行 URL 编码，例如密码 `p@ss:word` 应写成 `p%40ss%3Aword`。
+
+应用启动时会主动验证当前 `DATABASE_ENGINE` / `DATABASE_URL` 指向的数据库连接和 Redis `PING`。任一服务不可达、连接串错误或 Redis 密码不正确时，启动会立即抛出异常，不会提供半可用服务。需要在离线管理命令中临时跳过检查时，可设置 `DJANGO_VALIDATE_SERVICES_ON_STARTUP=false`；正常开发和生产环境应保持为 `true`。
+
+基础依赖使用纯 Python 的 `PyMySQL`，因此不要求本机安装 MySQL 编译工具链。生产环境如需使用 `mysqlclient` 优化，可自行额外安装；项目会优先使用它。更新依赖后执行 `python -m pip install -r requirements.txt`。
+
+### 4. 初始化数据库与管理员
+
+本次核心模型采用新的初始迁移；开发环境请按约定删除旧数据库后再执行迁移，避免将旧的业务表结构与新的 CMS 核心混用。
+
+```bash
+python manage.py migrate
+python manage.py sync_cms_plugins
+python manage.py createsuperuser
+```
+
+### 5. 启动开发服务器
+
+```bash
+python manage.py runserver
+```
+
+启动后访问：
+
+| 地址 | 用途 |
+| --- | --- |
+| http://127.0.0.1:8000/ | CMS 内容入口 |
+| http://127.0.0.1:8000/eadmin/ | EAdmin：自定义 Tailwind/DaisyUI 管理后台 |
+| http://127.0.0.1:8000/django-admin/ | 保留的 Django 原生管理后台 |
+
+`/eadmin/` 与 `/django-admin/` 均需使用上一步创建的管理员账户登录。日常管理请使用 `/eadmin/`；原生后台保留用于兼容与维护。
+
+## 常用命令
+
+```bash
+# 运行测试
+python manage.py test
+
+# 检查配置
+python manage.py check
+
+# 修改 models.py 后生成迁移
+python manage.py makemigrations
+
+# 生产部署时收集静态文件
+python manage.py collectstatic --noinput
+```
+
+## 主题切换
+
+当前主题由 `CMS_THEME` 环境变量决定，而不是数据库数据。项目内置：
+
+```dotenv
+# 默认简洁主题
+CMS_THEME=default
+
+# DaisyUI 复古主题
+CMS_THEME=daisy_retro
+```
+
+修改 `.env` 后重启 `runserver`。新增主题需放在 `templates/themes/<主题名>/`，并至少提供 `base.html`、`index.html`、`detail.html`。
+
+## 插件
+
+核心采用 django CMS 同类的组合式模型：内容节点拥有命名的 `Placeholder`（占位符），占位符按顺序承载可嵌套的 `PluginInstance`（插件实例）。`PluginType` 只描述由扩展提供的插件类型；具体字段存放在插件实例的结构化数据中。模板使用 `{% load cms_plugins %}` 与 `{% render_placeholder placeholder %}` 渲染插件树。因此富文本、图片、表单、互动或任何领域能力都由独立插件实现，不写入 CMS 核心表。
+
+插件目录为 `plugins/<插件名>/plugin.py`，通过 `register(registry)` 注册。已发现扩展的启用状态与配置保存在 `PluginRecord`。应用可自行注册插件类型、渲染器及数据校验，不需要修改核心模型。
+
+每次新增或更新插件定义后执行 `python manage.py sync_cms_plugins`，将代码中的插件标识、名称和 Schema 同步到后台可管理的 `PluginType`；该命令不会删除已有插件数据。
+
+## EAdmin
+
+`eadmin/` 是独立的 Django app，不依赖或覆盖原生 `django.contrib.admin`。它使用自己的注册器、路由和模板，默认地址为 `/eadmin/`。业务模型在各应用的 `eadmin.py` 中注册：
+
+```python
+from eadmin.registry import ModelAdmin, site
+from .models import Content
+
+site.register(Content, ModelAdmin(
+    list_display=("label", "state", "updated_at"),
+    search_fields=("label", "key"),
+    fields=("label", "key", "state", "data"),
+))
+```
+
+包本身只提供通用注册器、权限、CRUD 视图与 Tailwind CSS、DaisyUI、HTMX、Alpine.js 模板；项目特定模型注册放在应用自己的 `eadmin.py`，因此后续可直接抽离为独立包。
+
+关系字段遵循统一规则：`OneToOneField` 与 `ForeignKey` 使用单选下拉框；`ManyToManyField` 默认使用下拉多选。反向一对多关系使用 EAdmin 的 `InlineModelAdmin` 声明。对于数据量很大或权限分配等特殊场景，注册项可显式改用 `autocomplete_fields`、`raw_id_fields` 或 `filter_horizontal`，不会影响默认通用规则。
+
+### 作为独立包安装
+
+EAdmin 已具备 reusable app 的打包配置，发布到 PyPI 后可通过 `python -m pip install django-eadmin` 使用；当前仓库开发时执行 `python -m pip install -e .`。将 `eadmin.apps.EAdminConfig` 放在 `INSTALLED_APPS` 前部，添加 `eadmin.context_processors.navigation`，并通过 `path("eadmin/", include("eadmin.urls"))` 挂载即可。它不会覆盖原生 `/django-admin/`；完整接入示例见 [`README-eadmin.md`](README-eadmin.md)。
+
+## 无 PostgreSQL 时的临时测试
+
+正式开发和生产应使用 PostgreSQL。仅在临时运行测试且本机没有 PostgreSQL 时，可以用 SQLite 覆盖连接：
+
+```bash
+DATABASE_URL=sqlite:///db.sqlite3 python manage.py migrate
+DATABASE_URL=sqlite:///db.sqlite3 python manage.py test
+```
+
+这只是便捷方案，不应作为生产配置。

django_eadmin-0.1.0/django_eadmin.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: django-eadmin
+Version: 0.1.0
+Summary: A reusable Tailwind, HTMX, Alpine.js, and DaisyUI Django administration app.
+Author: EAdmin contributors
+License-Expression: LicenseRef-Proprietary
+Project-URL: Documentation, https://github.com/django-cms/django-cms
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Django<5.3,>=5.1
+
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration app built
+with Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It provides a separate
+`/eadmin/` workspace and does not replace Django's built-in `/admin/` site.
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Put `eadmin` before applications that register models so its templates and
+static assets are discovered first:
+
+```python
+INSTALLED_APPS = [
+    "eadmin.apps.EAdminConfig",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    # …remaining Django and project apps
+]
+
+TEMPLATES[0]["OPTIONS"]["context_processors"] += [
+    "eadmin.context_processors.navigation",
+]
+```
+
+Mount its URLs separately from the native admin:
+
+```python
+from django.urls import include, path
+
+urlpatterns = [
+    path("eadmin/", include("eadmin.urls")),
+    path("admin/", admin.site.urls),
+]
+```
+
+## Register models
+
+Create an `eadmin.py` in any installed Django app:
+
+```python
+from eadmin.registry import ModelAdmin, site
+from .models import Article
+
+site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+EAdmin discovers these registrations through the installed app configuration.
+It applies Django model permissions to every page and action. By default,
+one-to-one and foreign-key fields use a single select; many-to-many fields use
+a multi-select dropdown. Registrations can opt into autocomplete, raw-ID, or
+transfer controls for exceptional relationships.
+
+## Development install
+
+From a checkout containing this package:
+
+```bash
+python -m pip install -e .
+```

django_eadmin-0.1.0/django_eadmin.egg-info/SOURCES.txt

@@ -0,0 +1,39 @@
+MANIFEST.in
+README-eadmin.md
+README.md
+pyproject.toml
+django_eadmin.egg-info/PKG-INFO
+django_eadmin.egg-info/SOURCES.txt
+django_eadmin.egg-info/dependency_links.txt
+django_eadmin.egg-info/requires.txt
+django_eadmin.egg-info/top_level.txt
+eadmin/__init__.py
+eadmin/apps.py
+eadmin/context_processors.py
+eadmin/forms.py
+eadmin/permissions.py
+eadmin/py.typed
+eadmin/registry.py
+eadmin/urls.py
+eadmin/views.py
+eadmin/static/eadmin/eadmin.css
+eadmin/static/eadmin/eadmin.js
+eadmin/static/eadmin/logo.svg
+eadmin/templates/eadmin/base.html
+eadmin/templates/eadmin/dashboard.html
+eadmin/templates/eadmin/login.html
+eadmin/templates/eadmin/model_detail.html
+eadmin/templates/eadmin/model_form.html
+eadmin/templates/eadmin/model_history.html
+eadmin/templates/eadmin/model_list.html
+eadmin/templates/eadmin/password_form.html
+eadmin/templates/eadmin/partials/object_table.html
+eadmin/templates/eadmin/widgets/autocomplete.html
+eadmin/templates/eadmin/widgets/datetime.html
+eadmin/templates/eadmin/widgets/multiselect.html
+eadmin/templates/eadmin/widgets/raw_id.html
+eadmin/templates/eadmin/widgets/select.html
+eadmin/templates/eadmin/widgets/transfer_select.html
+eadmin/templatetags/__init__.py
+eadmin/templatetags/eadmin.py
+eadmin/tests/__init__.py

django_eadmin-0.1.0/django_eadmin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_eadmin-0.1.0/django_eadmin.egg-info/requires.txt

@@ -0,0 +1 @@
+Django<5.3,>=5.1

django_eadmin-0.1.0/django_eadmin.egg-info/top_level.txt

@@ -0,0 +1 @@
+eadmin

django_eadmin-0.1.0/eadmin/__init__.py

@@ -0,0 +1,6 @@
+"""EAdmin: a standalone, HTMX-friendly Django management interface."""
+
+default_app_config = "eadmin.apps.EAdminConfig"
+"""Reusable Django EAdmin application."""
+
+__version__ = "0.1.0"

django_eadmin-0.1.0/eadmin/apps.py

@@ -0,0 +1,12 @@
+from django.apps import AppConfig
+
+
+class EAdminConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "eadmin"
+    verbose_name = "EAdmin"
+
+    def ready(self):
+        from .registry import site
+        site.autodiscover()
+

django_eadmin-0.1.0/eadmin/context_processors.py

@@ -0,0 +1,29 @@
+from django.apps import apps
+from django.conf import settings
+
+from .registry import site
+from .views import admin_verbose_name
+
+
+def navigation(request):
+    current_model_name = getattr(request.resolver_match, "kwargs", {}).get("model_name")
+    groups = {}
+    entries = []
+    for model, config in site.visible_entries(request):
+        entry = {"model_name": model._meta.model_name, "verbose_name": admin_verbose_name(model, config), "config": config}
+        entries.append(entry)
+        key = config.menu_group or model._meta.app_label
+        group = groups.setdefault(key, {
+            "key": key,
+            "label": config.menu_group_label or apps.get_app_config(model._meta.app_label).verbose_name,
+            "icon": config.menu_group_icon or config.icon,
+            "entries": [],
+            "active": False,
+        })
+        group["entries"].append(entry)
+        group["active"] = group["active"] or current_model_name == model._meta.model_name
+    return {
+        "eadmin_navigation": entries,
+        "eadmin_navigation_groups": tuple(groups.values()),
+        "eadmin_timezone": settings.TIME_ZONE,
+    }