get-started

新しい Keboola コンポーネントを初期化する

コードを書く前に、コンポーネントがすでに初期化されているか確認してください。

ステップ 1：状態を検出する

既存の cookiecutter セットアップの兆候を確認します。

ls src/component.py component_config/ pyproject.toml 2>/dev/null

• すべて存在する場合 → 初期化をスキップし、すぐに @develop-component へ引き継ぎます
• 不足している場合、またはリポジトリが空の場合 → 以下の手順で初期化します

ステップ 2：コンポーネント情報を収集する

会話からコンポーネントの詳細がすでに分かっている場合があります。分からない場合は、次の情報を確認してください。

• コンポーネント名 — ケバブケースで、タイプの接尾辞は付けません（例：ex-salesforce。salesforce-extractor ではありません）
• コンポーネント ID — vendor.component-name 形式（例：keboola.ex-salesforce）
• タイプ — extractor、writer、application のいずれか
• 短い説明 — 機能を説明する 1 文

命名規則：

• 名前自体に「extractor」、「writer」、「application」を含めないでください
• 接頭辞の規則を使用します。extractor には ex-、writer には wr- を付けます

ステップ 3：cookiecutter を実行する

# Install if missing
which cookiecutter || pip install --user cookiecutter

cookiecutter gh:keboola/cookiecutter-python-component

ユーザーが値を確認できるよう、対話形式で実行してください。テンプレートにより、サンプルファイルを含む src/、component_config/、tests/、.github/workflows/、Dockerfile、pyproject.toml、data/ が作成されます。

ステップ 4：整理して設定する

# Remove the generic example files that come with the template
find data -type f -delete

# Recreate the expected directory structure
mkdir -p data/in/tables data/in/files data/out/tables data/out/files

次に、コンポーネントの実際の機能に基づいた現実的なサンプルパラメーターを使って、data/config.json を作成します。一般的なプレースホルダーは使用しないでください。component_config/configSchema.json にすでに内容がある場合は読み込み、必須フィールドに対応する妥当なサンプル値を設定します。機密フィールドには # を接頭辞として付けます（例："#api_key"）。

ステップ 5：初回コミット

git add -A
git commit -m "feat: initialize component from cookiecutter template"

ステップ 6：引き継ぐ

初期化が完了したら、実装を開始するために @develop-component へ引き継ぎます。コンポーネントの目的について分かっていることを共有し、背景情報を伝えてください。

---

主なリソース

• Cookiecutter テンプレート：gh:keboola/cookiecutter-python-component
• Developer Portal：https://components.keboola.com/
• コンポーネントのチュートリアル：https://developers.keboola.com/extend/component/tutorial/