用于合并级联 toml 文件的命令
项目描述
简介
将 toml "数据库" 级联为其完整对象的命令
TOML 级联是文件树,用于定义通用配置。级联允许在一个地方设置共享设置。
级联的根有两个文件定义它
.cascade.toml
定义了cascadetoml
的设置。设置是paths
是一个字符串列表,每个字符串都是一种 Python 格式化字符串。这些字符串用于提取由路径定义的设置。
<type>.template.toml
定义了生成的 TOML 对象的完整结构。<type>
用于在级联导致多个对象时输出数组表的名字。表格中的键是树内 TOML 文件中允许的唯一键。值的类型也必须保持一致。
特定文件夹的设置在一个以文件夹名字加上 .toml
扩展名的 TOML 文件中。
使用此功能的第一个存储库是 nvm.toml
存储库。它的唯一路径是 {technology}/{manufacturer}/{sku}.toml
。例如,flash/gigadevice/GD1.toml
文件将具有隐含值
technology = "flash"
manufacturer = "gigadevice"
sku = "GD1"
所有其他值按顺序来自这些文件
flash/flash.toml
flash/gigadevice/gigadevice.toml
flash/gigadevice/GD1.toml
不允许存在多级重复的键。
cascadetoml check
可以用来验证大部分内容。
从 PyPI 安装
为当前用户安装
pip3 install cascadetoml
全局安装(在某些情况下可能需要这样做)
sudo pip3 install cascadetoml
在当前项目的虚拟环境中安装
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install cascadetoml
为开发安装
cascadetoml
使用 flit 进行打包。要将开发副本安装到当前的虚拟环境中,请执行
flit install -s --deps develop
安装后,您只需直接编辑文件,虚拟环境将使用源文件。
贡献
欢迎贡献!请在贡献之前阅读我们的 行为准则,以帮助该项目保持欢迎。
文档
有关构建库文档的信息,请参阅 本指南。