配置套件是认识到软件配置复杂性的结果。
configsuite的Python项目详细描述
配置套件
简介
从用户和开发人员的角度来说,识别软件配置的复杂性是一个结果。我们的主要目标是对这种复杂性保持透明。特别是,我们的目标是在提供有效配置时向用户提供确认,在配置无效时提供具体帮助,并提供最新的文档来协助此项工作。对于开发人员,我们的目标是提供一个套件,它将以无缝的方式处理多个数据源的配置有效性,完全消除特殊大小写和有效性检查的负担,并自动生成最新的文档。我们还相信,处理开发早期正式验证配置的复杂性会导致更好地设计配置。功能
- 验证配置。
- 在适用的情况下,提供错误的详细列表。
- 输出一个不可变的配置对象,其中提供了所有值。
- 支持多个数据源,在当前配置的基础上提供默认值以及用户和工作区配置的可能性。
- 生成符合技术要求的文档。
- 不会基于用户输入抛出异常(对于validators,这目前不是真的)。
- 基于上下文的验证器和转换。
文档
未来
看看githubrepository中的史诗和问题。
安装
获取最新版本config suite的最简单方法是通过PyPI。
pip install configsuite
开发人员指南
非常欢迎对config suite的贡献!错误报告、功能请求和文档或类似代码的改进。然而,如果你正在计划一个更大的工作或引入一个概念,那么就鼓励在一个问题上发起讨论。
运行测试
可以使用python setup.py test
执行测试。请注意,代码格式化测试将仅使用python3.6
或更高版本执行。
代码格式化
整个代码基的格式为black。
拉取请求期望值
我们希望对较小的公关有一个很好的解释,对较大的贡献有一个参考问题。此外,我们希望测试通过所有提交,并以命令式方式编写提交消息。有关提交消息的更多信息,请阅读this。
许可证
config suite在mit许可下获得许可。有关更多信息,请参阅 阅读LICENSE file。