自定义新项目

正如你在入门指南部分所看到的，当你安装好Kedro后，可以通过kedro new命令创建新项目，并根据项目所需的工具和示例代码需求自定义添加到该项目中的代码。

本部分页面详细描述了可用的各种选项。

使用kedro new创建基础项目
最简单的场景是，您可以使用kedro new创建项目，并从一系列工具和示例代码选项中选择来扩展基础项目。

使用 kedro new 并带上 --config 参数
同样地，你可以使用 kedro new 命令，但额外传入一个配置文件，例如：

kedro new --config=config.yml

该文件允许您自定义项目文件夹名称和包名称等详细信息。

配置文件必须包含：

• output_dir 创建项目目录的路径，可以设置为 ~ 表示主目录或 . 表示当前工作目录

• project_name

• repo_name

• python_package

此外，配置文件可能包含：

• tools: 用于自定义项目设置的工具。可从以下逗号分隔值中选择：lint, test, log, docs, data, pyspark, viz 或 all/none。若在配置文件中省略此项，将默认选择 none。

• example_pipeline: 选择yes或no来指定是否希望项目包含示例代码。如果配置文件中省略此项，将默认选择no。

output_dir可以指定为~表示主目录，或.表示当前工作目录。以下是一个config.yml示例，假设已存在名为~/code的目录：

output_dir: ~/code
project_name: My First Kedro Project
repo_name: testing-kedro
python_package: test_kedro

注意

当--config标志与--name、--tools或--example一起使用时，直接在命令行界面提供的值将覆盖配置文件中指定的值。

使用kedro new命令并带上--starter参数
您可以通过starter创建一个新的Kedro项目，该starter会为常见项目用例添加代码。

重要

您不能将Kedro starter的使用与上述列出的工具和示例代码选项结合使用。