environ-config 项目使用指南

environ-config 项目使用指南

environ-configPython Application Configuration With Environment Variables项目地址:https://gitcode.com/gh_mirrors/en/environ-config

项目介绍

environ-config 是一个用于简化配置管理的 Python 库，它允许开发者通过环境变量来配置应用程序。这个库的主要优势在于其简洁的 API 和灵活的配置方式，使得配置管理变得轻松且高效。

项目快速启动

安装

首先，你需要通过 pip 安装 environ-config：

pip install environ-config

基本配置

以下是一个简单的示例，展示如何使用 environ-config 来配置一个应用程序：

import environ

@environ.config
class AppConfig:
    value = environ.var(help="这是一个值")
    flag = environ.bool_var(help="这是一个布尔标志")

# 加载配置
config = AppConfig.from_environ()
print(config)

在这个示例中，我们定义了一个 AppConfig 类，并通过环境变量来加载配置。

应用案例和最佳实践

案例一：使用 AWS Secrets Manager

如果你需要从 AWS Secrets Manager 中获取配置，可以安装 environ-config[aws] 并进行如下配置：

import environ

@environ.config
class AppConfig:
    db_url = environ.secret(help="数据库连接URL")

# 加载配置
config = AppConfig.from_environ()
print(config)

最佳实践

1. 使用环境变量：尽可能使用环境变量来配置应用程序，这样可以方便地进行配置管理和部署。
2. 配置分离：将配置分为多个部分，每个部分负责不同的功能，这样可以提高代码的可维护性。
3. 安全存储：对于敏感信息，如数据库密码等，应使用专门的存储系统，如 AWS Secrets Manager。

典型生态项目

attrs

attrs 是一个用于简化类定义的库，它与 environ-config 结合使用可以进一步简化配置类的定义：

import attr
import environ

@environ.config
class AppConfig:
    value = environ.var(help="这是一个值")
    flag = environ.bool_var(help="这是一个布尔标志")

@attr.s
class App:
    config = attr.ib(factory=AppConfig.from_environ)

app = App()
print(app.config)

INI 文件支持

environ-config 还支持从 INI 文件中加载配置，这对于需要复杂配置的应用程序非常有用：

import environ

ini_file = environ.secrets.INISecrets.from_path_in_env(
    "APP_SECRETS_INI", "/secrets/secrets.ini"
)

@environ.config
class AppConfig:
    db_url = ini_file.secret()

# 加载配置
config = AppConfig.from_environ()
print(config)

通过这些生态项目的支持，environ-config 可以更好地满足不同场景下的配置管理需求。

environ-configPython Application Configuration With Environment Variables项目地址:https://gitcode.com/gh_mirrors/en/environ-config