python的官方doppler客户端
doppler-client的Python项目详细描述
多普勒python库
doppler python库提供了从 仅为编写的应用程序服务器端代码。
安装
安装软件包时使用:
pip install -U doppler-client
用法
需要使用您的帐户的api密钥(可在您的Doppler account中找到)、管道标识符和环境名称来配置包:
所需环境变量
请将这些环境变量添加到根目录或Infra提供程序中的.env
文件中。
DOPPLER_API_KEY = <API Key>
DOPPLER_PIPELINE = <Pipeline ID>
DOPPLER_ENVIRONMENT = <Environment Name>
查找优先级
多普勒将在3个位置查找这些变量,优先级如下:
- 作为初始化参数传入
- 从环境变量中读取
- 从
.env
文件读取
使用环境变量安装
此安装方法将期望DOPPLER_API_KEY
、DOPPLER_PIPELINE
、DOPPLER_ENVIRONMENT
作为环境变量
fromdoppler_clientimportDopplerDoppler()# Rest of Applicationexample_variable=os.getenv("EXAMPLE_VARIABLE")
使用env文件安装
此安装方法需要DOPPLER_API_KEY
、DOPPLER_PIPELINE
、DOPPLER_ENVIRONMENT
在.env
文件中。
fromdoppler_clientimportDopplerDoppler({"env_filepath":".env"# Defaults to ".env"})# Rest of Applicationexample_variable=os.getenv("EXAMPLE_VARIABLE")
带参数安装
此安装方法需要api_key
、pipeline
、environment
作为参数。
fromdoppler_clientimportDopplerDoppler({"api_key":os.getenv("DOPPLER_API_KEY"),"pipeline":os.getenv("DOPPLER_PIPELINE"),"environment":os.getenv("DOPPLER_ENVIRONMENT")})# Rest of Applicationexample_variable=os.getenv("EXAMPLE_VARIABLE")
关键最佳实践
所以如果doppler存储了我的环境变量,我应该在哪里保存doppler api密钥?
这是个很好的问题!我们建议您存储DOPPLER_API_KEY
、DOPPLER_PIPELINE
和DOPPLER_ENVIRONMENT
。
在.env
文件中或与您的基础设施提供商一起。这意味着你应该在本地环境中存储的唯一变量是多普勒键。所有其他变量应由多普勒客户端获取。
禁用覆盖环境变量
如果要禁用重写环境变量,请使用以下字段。
fromdoppler_clientimportDopplerdoppler=Doppler({"override":False})# Rest of Your Applicationexample_variable=doppler.get("EXAMPLE_VARIABLE")
忽略特定变量
如果您想忽略多普勒的特定变量,比如heroku设置的端口,可以将其添加到ignore_variables
字段。
fromdoppler_clientimportDopplerDoppler({"ignore_variables":["PORT"]})
回退到备份
多普勒客户端在初始化时接受backup_filepath
。如果客户愿意的话
备份文件中的多普勒变量。如果多普勒客户端无法连接到我们的API
端点(非常不可能),客户端将回退到备份文件中提供的密钥。
fromdoppler_clientimportDopplerDoppler({"backup_filepath":"./backup.env"})