欢迎来到 SKBS

SKBS 表示骨架引导带。

SKBS 是一个功能强大的模板引擎，可用于从项目样板引导程序到代码生成的各种任务。

感谢 Tempiny，skbs 提供了一个模板语法，它只是 Python 代码，避免了学习另一种语言的需要。

此外，与其他模板语言相反，可以更改分隔符以避免转义。

特征

• 图灵完备
• 易于创建、安装、使用和共享模板
• 保留用户对先前生成的文件的编辑的部分
• 动态文件和目录名称
• 模板内单击集成以提供快速用户友好的类似 CLI 的选项
• 经过大量测试pytest

安装

pip是首选方式。然后你应该生成配置（只是模板的安装位置......）

默认情况下，配置安装在用户配置的默认位置（~/.local/config/skbs/对于 unix-like）

pip install skbs
skbs create-config

然后，您可以“安装” skbs 附带的默认模板（skbs和）（它们是创建模板的样板）。skbs.sft

我建议您阅读教程 ( https://github.com/hl037/skbs/wiki/Tutorial ) 以友好地介绍所有 skbs 功能和 API_Reference ( https://github.com/hl037/skbs/wiki/ API_Reference）如果您需要更多详细信息

用法

Usage: skbs [OPTIONS] COMMAND [ARGS]...

Options:
  -c, --config PATH  Overide the default configuration path
  --help             Show this message and exit.

Commands:
  config-path       Prints the path to the in-use configuration file.
  create-config     Create / reset to default the configuration file.
  gen               Generate a skeleton from a template.
  install           Install a new template.
  install-defaults  Install default provided templates
  list              List installed templates.
  uninstall         Uninstall a template uninstall         Uninstall a template

的使用skbs gen

Usage: skbs gen [OPTIONS] TEMPLATE DEST [ARGS]...

  Generate a skeleton from a template.

  template : if template starts with an '@', it will look for an installed
  template. Else, it will be considered as the template path. dest : the
  output directory (parents will be created if needed) args : argument passed
  to the template ( skbs gen <template_name> -- --help for more informations )

Options:
  -g, --debug
  --stdout           Only for single file templates : output to stdout.
                     --single-file is implied
  -s, --single-file  Authorize single file template for non installed
                     templates.
  --help             Show this message and exit.

（非常）快速入门

本节将仅涵盖非常基本的内容，不做过多解释，仅将其视为备忘单。阅读完整的教程 ( https://github.com/hl037/skbs/wiki/Tutorial ) 以充分利用 SKBS 的潜力。

您可能还会发现 API_Reference ( https://github.com/hl037/skbs/wiki/API_Reference ) 很有用

安装默认提供的模板：

skbs install-default

要请求模板的帮助，请使用@help作为目标（或作为第一个模板参数传递--help，在--:

skbs gen @skbs.sft @help
#or
skbs gen @skbs.sft foo_bar -- --help

要创建一个独立的单个文件模板：

skbs gen @skbs.sft my_template -- -c

my_template你想给它起的名字在哪里。编辑我的模板。

任何以一行开头的文件：

## # {{__skbs_template__}}

被认为是一个动态文件，具有 python 支持。如果此行不存在，则将其视为原始文件并按原样复制。

以 python 开头的每一行##，不输出。缩进级别在以 结尾的行上增加:，在包含单个 . 的行上减少-。

其他行按原样打印（如果 python 执行流程再次到达它们，可能会多次打印）。

{{并}}在正常行中分隔 python 表达式。它被评估并且其结果替换整个{{...}}模式。

可以通过修改教程 ( https://github.com/hl037/skbs/wiki/Tutorial ) 中描述的标题行来更改此语法。

创建多文件模板：

skbs gen skbs my_second_template -- -c

my_second_template模板名称在哪里。

内部my_second_template,plugin.py是您可以在 .args之后解析用户提供的参数的入口点--。

目录的内容root将被放入用户提供的目标中，每个文件都将检查模板标题行，如果找到，将像自包含的单个文件模板一样解析和执行。

安装模板（或包含模板的目录：

skbs install -s my_template -n <name>

Where<name>应替换为您要用于调用模板的名称。

您可以列出已安装的模板：

skbs list

...然后您可以使用以下命令调用此列表中的任何模板：

skbs gen @<name> [...]

<name>中出现的行在哪里skbs list。