Django-environ 使用教程

1. 项目介绍

Django-environ 是一个Python包，用于在Django项目中采用12因子方法来管理环境变量配置。它使开发者能够方便地从环境文件或操作系统提供的环境变量中获取并配置Django应用。

通过使用django-environ，你可以将敏感的应用设置如数据库密码、API密钥等存放在环境变量中，这有助于保持项目配置的灵活性和安全性。

2. 项目快速启动

首先，确保你的Python环境中已经安装了django-environ。如果没有，可以使用以下命令进行安装：

pip install django-environ

接下来，在你的Django项目的根目录下创建一个名为 .env 的环境文件，例如：

.env
SECRET_KEY=mysecretkey
DEBUG=True
ALLOWED_HOSTS=localhost,127.0.0.1

然后，在settings.py 文件中导入 environ 模块并配置环境变量：

import environ
from pathlib import Path

env = environ.Env()
env.read_env(str(Path('.') / '.env'))

SECRET_KEY = env('SECRET_KEY')
DEBUG = env.bool('DEBUG', default=False)
ALLOWED_HOSTS = env.list('ALLOWED_HOSTS')

# 其他Django配置...

这样，Django应用就可以读取.env文件中的环境变量进行设置了。

3. 应用案例和最佳实践

• 安全存储敏感数据：将数据库连接字符串、API秘钥等敏感信息作为环境变量处理，不将其硬编码在源代码中。
• 开发和生产环境差异：根据不同的环境（如开发、测试、生产）设置不同的环境变量，如开启或关闭调试模式。
• 部署自动化：在部署过程中，可以通过操作系统的环境变量或者容器化工具（如Docker）来轻松设定这些变量。

4. 典型生态项目

• Docker：配合Docker的环境变量功能，可以在不同容器实例间轻松地切换配置。
• Kubernetes (K8s)：在Kubernetes集群中，可以利用ConfigMaps或Secrets来管理应用的环境变量。
• Heroku：Heroku支持通过其平台设置环境变量，与django-environ结合非常方便。

通过以上步骤，你应该了解了如何使用django-environ来管理和配置Django应用。为了实现最佳实践，推荐对敏感环境变量进行加密，并在生产环境中严格控制它们的访问权限。