2.2. 使用 Cookiecutter 创建 Python S2I 应用程序
您可以使用 Cookiecutter 快速创建适合 Red Hat OpenShift AI 的应用程序。Cookiecutter 是一个 Python 库,可为您的数据科学工作创建一个灵活、标准化的项目结构。您可以使用 Cookiecutter 来进一步自定义项目的存储库。例如,您可以修改存储库的目录结构,以满足您的项目的要求。
先决条件
- 启动并运行 Jupyter 服务器。
- 您有一个 GitHub 帐户。
- 您有凭证来访问包含您要使用的相关模板的 GitHub 存储库。
流程
-
在 JupyterLab 界面中,点 File
New Terminal。 在终端中,运行
pip install
命令来安装 Cookiecutter。pip install cookiecutter
pip install cookiecutter
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 运行
cookiecutter
命令,从 Cookiecutter 存储库模板创建项目。cookiecutter template-repository-URL
cookiecutter template-repository-URL
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将 template-repository-URL 替换为模板存储库的 URL:
https://github.com/opendatahub-io/odh-s2i-project-cookiecutter
提示时,提供以下信息:
- 项目的名称。
- 存储库的名称。
- 项目的作者名称。
- 项目的描述。
您的开源许可证文件类型。
Cookiecutter 模板存储库的内容显示在左侧栏中的 File Browser 中。
在 GitHub 中创建存储库。
在 GitHub 主页右上角,点击 +
New repository。 这时将打开 Create a new repository 页面。
- 在 Repository template 字段中,选择要使用的模板。
- 可选: 选择 Include all branch 复选框,将模板存储库的分支复制到您的新存储库中。
- 在 Owner 字段中,选择存储库所有者的用户名。
- 在 Repository name 字段中,输入存储库的名称。
- 可选:在 Description 字段中输入存储库的描述。
设置存储库的可见性级别。
- 为确保存储库对任何人可见,请保留 Public (公共)。默认情况下,存储库的可见性设置为 Public。
- 点 Private 以选择哪些用户可以查看存储库并提交到存储库。
- 点 Create repository。
在您的 Jupyter 服务器上克隆存储库。
在 JupyterLab 界面中,点 Git
Clone a Repository。 此时会显示克隆存储库对话框。
- 输入您要克隆的存储库的 URL。
单击 Clone。
克隆的存储库位于左侧栏中的文件浏览器中。
- 在文件浏览器中,将 Cookiecutter 创建的文件和目录移到您克隆的存储库。
将您的更改推送到远程存储库。
-
在左侧侧边栏中,点 Git (
)。
-
如果您有未跟踪的更改,请在 Changes 选项卡中将光标悬停在 Untracked 部分栏上,然后点
。
-
如果您的文件包含更改,在 Changes 选项卡中,将光标悬停在 Changed 部分栏上,点
。
- 在 Required 字段中,输入您的更改概述。
- 在 Description 字段中,输入您的更改描述。
- 点 Commit。
在 JupyterLab 接口中,点击 Git
Push to Remote 将您的更改推送到远程存储库。 此时会打开所需的 Git 凭证。
- 输入您的凭证来访问远程存储库。
- 点击 确定。
-
在左侧侧边栏中,点 Git (
验证
- 您可以访问从模板创建的远程存储库。
- 您可以查看推送在远程存储库中的更改。