轻松设置应用程序或库的配置。
configureme的Python项目详细描述
配置我
轻松设置应用程序或库的配置。
功能
configureme提供了一些关键功能,使您在创建库或应用程序时的生活更轻松:
- 按照config.py模式轻松创建配置
- 在配置中使用环境变量,并在运行时动态更改它们
- 使用.env文件并遵循twelve-factor app方法
示例
快速启动并运行完整配置:
fromconfiguremeimportConfigclassConfig(object):DEBUG=Falseconfig=Config()# load from a simple objectconfig.from_object(Config)# add and watch environment variablesconfig.from_envar("DEBUG")# use a dotenv fileconfig.from_dotenv("/path/to/.env/")# config works like a dict!config["DEBUG"]# True
安装
使用pip很容易安装:
pip install configureme
高级用法
与pipenv一起使用
如果使用像Pipenv这样的开发人员工作流工具,则可以轻松地将configureme与之配对。pipenv将自动为您加载.env文件。要在使用pipenv时跟踪从.env文件加载的变量,只需使用以下模式:
# .env file DEBUG=true
fromconfiguremeimportConfigconfig=Config()# watch each variable loaded by Pipenvconfig.from_envar("DEBUG")config["DEBUG"]# True
与python dotenv一起使用
python-dotenv是在多个环境中管理.env文件的有用工具。与前面的示例一样,很容易与configureme配对。
# .env file DEBUG=true
fromdotenvimportload_dotenvfromconfiguremeimportConfigload_dotenv()config=Config()# watch each variable loaded by python-dotenvconfig.from_envar("DEBUG")config["DEBUG"]# True
如何贡献
检查打开的问题或打开一个新的问题,开始围绕功能想法或错误的讨论。
分叉github上的存储库,开始对主分支(或其分支)进行更改。
编写一个测试,显示错误已修复或功能按预期工作。也一定要用pre-commit!
发送一个pull请求并对维护程序进行bug操作,直到它被合并并发布。一定要加入作者行列。