Django Newsletter 项目技术文档

1. 安装指南

1.1 环境要求

• Python 3.7 及以上版本
• Django 2.2.x LTS, 3.1.x 或 3.2.x

1.2 安装步骤

1. 使用 pip 安装 django-newsletter：

   pip install django-newsletter
   

2. 在 Django 项目的 settings.py 文件中添加 django_newsletter 到 INSTALLED_APPS：

   INSTALLED_APPS = [
       ...
       'django_newsletter',
       ...
   ]
   

3. 运行数据库迁移命令以创建必要的表：

   python manage.py migrate
   

2. 项目使用说明

2.1 创建和管理邮件列表

1. 登录 Django 管理后台。
2. 导航到 Newsletter 部分，创建新的邮件列表。
3. 配置邮件列表的模板、发送频率等参数。

2.2 发送邮件

1. 在管理后台中选择要发送的邮件列表。
2. 创建新的邮件内容，支持纯文本和 HTML 格式。
3. 点击发送按钮，系统将自动处理邮件发送任务。

2.3 订阅与退订

• 用户可以通过嵌入的表单在网站上订阅或退订邮件列表。
• 管理员可以在管理后台手动添加或删除订阅者。

3. 项目 API 使用文档

3.1 订阅 API

• URL: /newsletter/subscribe/
• 方法: POST
• 参数:
  • email: 订阅者的邮箱地址
  • list_id: 邮件列表的 ID
• 返回值:
  • 成功时返回 200 OK，失败时返回相应的错误信息。

3.2 退订 API

• URL: /newsletter/unsubscribe/
• 方法: POST
• 参数:
  • email: 订阅者的邮箱地址
  • list_id: 邮件列表的 ID
• 返回值:
  • 成功时返回 200 OK，失败时返回相应的错误信息。

4. 项目安装方式

4.1 通过 pip 安装

pip install django-newsletter

4.2 从源码安装

1. 克隆项目仓库：

   git clone https://github.com/jazzband/django-newsletter.git
   

2. 进入项目目录并安装依赖：

   cd django-newsletter
   pip install -r requirements.txt
   

3. 将 django_newsletter 添加到 Django 项目的 INSTALLED_APPS 中，并运行迁移命令。

---

通过以上步骤，您可以成功安装并使用 django-newsletter 项目来管理多邮件列表的邮件发送任务。如有任何问题，请参考项目的 GitHub Issues 或提交新的问题。