2.2. Cookiecutter を使用した OpenShift Data Science の Python S2I アプリケーションの作成

Cookiecutter を使用して、Red Hat OpenShift Data Science に適したアプリケーションをすばやく作成できます。Cookiecutter は、データサイエンスの作業用に柔軟で標準化されたプロジェクト構造を作成する Python ライブラリーです。Cookiecutter を使用してプロジェクトのリポジトリーをさらにカスタマイズできます。たとえば、プロジェクトの要件に合わせてリポジトリーのディレクトリー構造を変更できます。

前提条件

  • 起動済みで実行中の Jupyter サーバー。
  • GitHub アカウント。
  • 使用するテンプレートが格納された GitHub リポジトリーにアクセスするための認証情報。

手順

  1. JupyterLab インターフェイスで、FileNewTerminal をクリックします。
  2. ターミナルで pip install コマンドを実行して Cookiecutter をインストールします。

    pip install cookiecutter
  3. cookiecutter コマンドを実行して、Cookiecutter のリポジトリーテンプレートからプロジェクトを作成します。

    cookiecutter template-repository-URL

    template-repository-URL をテンプレートリポジトリーの URL (https://github.com/opendatahub-io/odh-s2i-project-cookiecutter) に置き換えます。

  4. プロンプトが表示されたら、以下の情報を指定します。

    1. プロジェクトの名前。
    2. リポジトリーの名前。
    3. プロジェクトの作成者の名前。
    4. プロジェクトの説明。
    5. オープンソースライセンスファイルのタイプ。

      Cookiecutter テンプレートリポジトリーの内容は、左側のサイドバーの File Browser に表示されます。

  5. GitHub でリポジトリーを作成します。

    1. GitHub ホームページの右上にある +New repository をクリックします。

      Create a new repository ページが開きます。

    2. Repository template フィールドで、使用するテンプレートを選択します。
    3. オプション: Include all branches チェックボックスを選択し、テンプレートリポジトリーのブランチを新規リポジトリーにコピーします。
    4. Owner フィールドで、リポジトリー所有者のユーザー名を選択します。
    5. Repository 名のフィールドに、リポジトリーの名前を入力します。
    6. オプション: Description フィールドに、リポジトリーの説明を入力します。
  6. リポジトリーの表示レベルを設定します。

    1. 誰でもリポジトリーを表示できるように、Public を選択します。デフォルトのリポジトリー表示レベルは Public に設定されています。
    2. Private をクリックして、リポジトリーを表示してコミットできるユーザーを選択します。
    3. Create repository をクリックします。
  7. Jupyter サーバーでリポジトリーのクローンを作成します。

    1. JupyterLab インターフェイスで、GitClone a Repository をクリックします。

      Clone a repo ダイアログが表示されます。

    2. クローンを作成するリポジトリーの URL を入力します。
    3. Clone をクリックします。

      クローン作成したリポジトリーは、左側のサイドバーの File Browser に表示されます。

    4. File Browser で、Cookiecutter で作成されたファイルおよびディレクトリーを、クローン作成したリポジトリーに移動します。
  8. 変更をリモートリポジトリーにプッシュします。

    1. 左側のサイドバーで Git ( The Git icon ) をクリックします。
    2. 変更を追跡していない場合は、Changes タブで、カーソルを Untracked セクションバーの上に置き、 jupyter git add or commit をクリックします。
    3. 変更が含まれるファイルがある場合は、Changes タブで、カーソルを Changed セクションバーの上に置き、 jupyter git add or commit をクリックします。
    4. Required フィールドに、変更の要約を入力します。
    5. Description フィールドに、変更の説明を入力します。
    6. Commit をクリックします。
    7. Jupyter インターフェイスで GitPush to Remote をクリックし、変更をリモートリポジトリーにプッシュします。

      Git credentials required ダイアログが開きます。

    8. リモートリポジトリーにアクセスするための認証情報を入力します。
    9. OK をクリックします。

検証

  • テンプレートから作成したリモートリポジトリーにアクセスできます。
  • リモートリポジトリーでプッシュした変更を確認できます。