Django Smuggler 技术文档

1. 安装指南

Django Smuggler 可以通过 Python 包索引（PyPI）进行安装。您可以使用 pip 或 easy_install 工具轻松安装最新稳定版本的 Smuggler。尝试执行以下命令：

pip install django-smuggler

或者：

easy_install django-smuggler

另外，您也可以从源代码安装 Smuggler，在包含 setup.py 文件的目录下运行以下命令：

python setup.py install

安装完成后，您需要配置项目以识别 Smuggler 应用程序。将 'smuggler' 添加到您的 INSTALLED_APPS 设置中，并设置项目的 URLConf：

urlpatterns = [
    # ...
    path('admin/', include('smuggler.urls')),  # 在 admin URL 模式之前！
    path('admin/', admin.site.urls),
]

2. 项目使用说明

安装完成后，通过以下 URL 可以访问 Smuggler 提供的功能：

• /admin/load/，用于从上传的文件或 SMUGGLER_FIXTURE_DIR 中的文件加载数据；
• /admin/dump/，用于下载整个项目的数据；
• /admin/APP_LABEL/dump/，用于下载特定应用的数据；
• /admin/APP_LABEL/MODEL_LABEL/dump/，用于下载特定模型的数据。

请注意，以上 URL 只有超级用户可以访问。

您还可以在模型的更改列表页面 (change_list.html) 上显示用于数据导出和导入的按钮。您可以按照以下方式设置感兴趣的 ModelAdmin：

class ExampleAdmin(admin.ModelAdmin):
    change_list_template = 'smuggler/change_list.html'
    ...

3. 项目API使用文档

Django Smuggler 的 API 使用主要是通过自动生成的管理界面进行。您可以通过管理界面的 /admin/load/ 和 /admin/dump/ 等路径来进行数据的导入和导出。

• 导出（Dump）: 通过 /admin/dump/ 可以导出整个项目或指定应用、模型的数据。可以通过查询字符串指定要导出的应用或模型，例如 /admin/dump/?app_label=flatpages,auth,yourapp.model。
• 导入（Load）: 通过 /admin/load/ 可以上传 fixture 文件来导入数据。如果设置了 SMUGGLER_FIXTURE_DIR，还可以直接从该目录加载数据文件。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明。简要概述如下：

• 使用 pip 或 easy_install 从 PyPI 安装；
• 从源代码目录使用 python setup.py install 命令安装。

安装后，确保将 'smuggler' 添加到 INSTALLED_APPS 中，并在 URLConf 中配置相应的 URL 模式。