wemake-django-template 使用教程

1. 项目介绍

wemake-django-template 是一个用于快速搭建 Django 项目结构的模板。它不仅提供了 Django 项目的基本结构，还集成了多种工具和配置，以确保代码质量、安全性和可扩展性。该项目的目标是提供一个开箱即用的 Django 项目模板，适用于大型项目和多人协作开发。

主要特性

• 依赖管理：使用 poetry 管理项目依赖。
• 静态类型检查：集成 mypy 和 django-stubs 进行静态类型检查。
• 单元测试：使用 pytest 和 hypothesis 进行单元测试。
• 代码风格检查：使用 flake8 和 wemake-python-styleguide 进行代码风格检查。
• 容器化：使用 docker 进行开发、测试和生产环境的统一管理。
• 持续集成：默认配置了 Gitlab CI，支持全自动的构建、测试和部署流程。
• 文档生成：使用 sphinx 生成项目文档。

2. 项目快速启动

安装依赖

首先，你需要安装 cookiecutter 和 jinja2-git。推荐使用 pipx 进行安装：

pipx install cookiecutter
pipx inject cookiecutter jinja2-git

或者使用全局 pip 安装：

pip install cookiecutter jinja2-git

创建项目

安装完成后，使用以下命令创建一个新的 Django 项目：

cookiecutter gh:wemake-services/wemake-django-template

启动项目

进入项目目录并启动开发服务器：

cd your_project_name
docker-compose up

3. 应用案例和最佳实践

应用案例

wemake-django-template 适用于需要高度规范化和自动化的大型项目。例如，一个多人在线协作平台、企业级管理系统或复杂的 API 服务。

最佳实践

• 代码质量：定期运行代码风格检查和静态类型检查，确保代码质量。
• 自动化测试：编写全面的单元测试和集成测试，确保代码的稳定性和可靠性。
• 持续集成：利用 Gitlab CI 进行自动化的构建、测试和部署，减少手动操作的错误。
• 文档维护：使用 sphinx 生成和维护项目文档，确保文档与代码同步更新。

4. 典型生态项目

依赖管理

• poetry：用于管理 Python 项目的依赖和版本。
• pipx：用于安装和运行 Python 应用程序，推荐用于安装 cookiecutter。

代码质量

• flake8：用于检查 Python 代码风格。
• wemake-python-styleguide：提供更严格的代码风格检查。

单元测试

• pytest：用于编写和运行单元测试。
• hypothesis：用于生成测试数据，提高测试覆盖率。

容器化

• docker：用于容器化应用，确保开发、测试和生产环境的一致性。
• docker-compose：用于管理多容器应用。

持续集成

• Gitlab CI：用于自动化构建、测试和部署流程。

文档生成

• sphinx：用于生成项目文档。

通过以上模块的介绍和实践，你可以快速上手并充分利用 wemake-django-template 提供的强大功能，构建高质量的 Django 项目。