Django StreamField 项目教程

1. 项目目录结构及介绍

Django StreamField 是一个实现了 Wagtail CMS 中 StreamField 概念的 Django 扩展，适用于普通的 Django admin 或者 Grappelli 皮肤。以下是项目的目录结构及其简单介绍：

django-streamfield/
├── frontend/              # 前端文件目录
├── streamfield/           # StreamField 核心代码目录
│   ├── migrations/        # 数据库迁移文件
│   ├── static/            # 静态文件目录
│   ├── templates/         # 模板文件目录
│   └── __init__.py        # 初始化文件
├── test_project/          # 测试项目目录
├── .gitignore             # Git 忽略文件
├── LICENSE                # 许可证文件
├── MANIFEST.in            # 打包配置文件
├── README.md              # 项目说明文件
├── changes2.0.md          # 版本变更记录
└── setup.py               # Python 包设置文件

2. 项目的启动文件介绍

项目的启动主要是通过 setup.py 文件来完成的。这个文件定义了如何打包和安装 Django StreamField 作为 Django 应用。以下是 setup.py 的基本内容：

from setuptools import setup, find_packages

setup(
    name='django-streamfield',
    version='2.3.2',
    packages=find_packages(),
    ...
)

要安装 Django StreamField，您需要在项目目录中运行以下命令：

pip install .

3. 项目的配置文件介绍

在 Django StreamField 中，主要的配置文件是 settings.py。虽然这个文件不是项目自带的，但是您在使用 Django StreamField 时需要在您的 Django 项目的 settings.py 文件中进行相应的配置。

以下是一些基本的配置步骤：

• 将 streamfield 和 streamblocks 添加到 INSTALLED_APPS：

INSTALLED_APPS = [
    # ...
    'streamblocks',
    'streamfield',
    # ...
]

• 运行迁移命令来创建数据库表：

python manage.py makemigrations
python manage.py migrate

• 添加 streamfield.urls 到主 urls.py 文件中：

urlpatterns += [
    path('streamfield/', include('streamfield.urls')),
]

• 对于每个块模型，创建相应的模板文件，例如对于 RichText 模型，创建 richtext.html。

通过这些步骤，您可以完成 Django StreamField 的基本配置并将其集成到您的 Django 项目中。