Django Grappelli 技术文档

1. 安装指南

环境准备

• Python：Python 3.8及以上版本
• Django：根据Grappelli的版本兼容性，选择对应的Django版本

安装步骤

1. 从PyPI安装Grappelli：

   pip install django-grappelli
   

2. 在Django项目的settings.py中添加grappelli到INSTALLED_APPS：

   INSTALLED_APPS = [
       # ...
       'grappelli',
       # ...
   ]
   

3. 在Django项目的urls.py中包含Grappelli的URL：

   from django.urls import include, path
   
   urlpatterns = [
       # ...
       path('admin/', include('grappelli.urls')),  # Grappelli URL
       path('admin/', include('django.contrib.admin.urls')),  # Django admin URL
       # ...
   ]
   

4. 运行Django项目的迁移命令来应用Grappelli的数据库迁移：

   python manage.py migrate
   

2. 项目使用说明

Grappelli为Django管理后台提供了一个时尚的皮肤和一系列增强功能。以下是一些主要特点：

• 清洁一致的界面风格
• 相关查找支持自动完成
• 可拖拽排序的行内表项
• 集成的TinyMCE主题
• 可自定义的管理仪表板
• 改进的折叠面板
• 统一的jQuery插件

使用Grappelli后，Django的管理界面将拥有更现代化的外观和更便捷的操作体验。

3. 项目API使用文档

Grappelli并没有直接提供的公开API，它主要是作为Django管理界面的一个扩展和美化工具。开发者可以通过自定义Django的admin模块来集成Grappelli的功能。

• 自定义仪表板：你可以通过继承Dashboard类并添加自定义模块来创建个性化的管理仪表板。
• 扩展模型表单：使用Grappelli的表单小部件，可以为模型表单添加更多的样式和功能。

有关Grappelli的详细使用和自定义方法，请参考官方文档。

4. 项目安装方式

除了通过PyPI安装外，你还可以通过以下方式安装Grappelli：

通过GitHub源码安装

1. 克隆GitHub仓库：

   git clone https://github.com/sehmaschine/django-grappelli.git
   

2. 将克隆的仓库添加到你的Python路径中，或将Grappelli目录加入到你的项目目录下。

3. 执行迁移命令。

请注意，从GitHub源码安装可能需要手动解决依赖问题，并确保与项目中使用的Django版本兼容。