GitHub Copilot SDK チュートリアル（Python）
Python 向け GitHub Copilot SDK を使って実際のアプリケーションを構築するためのステップバイステップガイドです。
SDK が初めての方は、まず言語依存しない 概要と概念（GitHub Copilot SDK とは何か・何でないか）と、 Copilot CLI のインストールと GitHub 認証を扱う 共通セットアップをご覧ください。このページは Python 版に焦点を当てます。
チュートリアル構成
各チュートリアルは解説ドキュメントとそのまま実行できる独立した CLI スクリプトをペアで提供します。
| # | チュートリアル | スクリプト | 学べること |
|---|---|---|---|
| 1 | CLI チャットボット | 01_chat_bot.py |
CopilotClient、セッション、プロンプト送信、インタラクティブループ |
| 2 | Issue トリアージボット | 02_issue_triage.py |
@define_tool によるカスタムツール、Pydantic I/O |
| 3 | ストリーミングレビュー | 03_streaming_review.py |
ASSISTANT_MESSAGE_DELTA によるストリーミング |
| 4 | スキルによるドキュメント生成 | 04_skills_docgen.py |
SKILL.md によるエージェントスキル |
| 5 | 監査ログ | 05_audit_hooks.py |
セッションフック、パーミッションハンドラ |
| 6 | BYOK Azure OpenAI | 06_byok_azure_openai.py |
Azure OpenAI を使った Bring Your Own Key |
すべてのスクリプトは
src/python/scripts/tutorials/にあります。
クイックスタート
まず Copilot CLI がインストール・認証済みであることを確認してください—共通の はじめにを参照。その上で:
# 1. SDK とチュートリアルの依存関係をインストール（src/python/pyproject.toml を利用）
cd src/python
uv sync --all-groups
# 2. チュートリアルスクリプトを実行（SDK がオンデマンドで CLI を起動）
uv run python scripts/tutorials/01_chat_bot.py --prompt "Hello, Copilot!"
Python 固有のセットアップについては はじめに（Python） を参照してください。
スコープ
含めるもの:
- GitHub Copilot SDK の概念説明（何であるか／何でないか）
- アーキテクチャと動作原理
- Python SDK の API 設計とインタフェース
- 具体的なユースケースに基づくサンプルコードとステップバイステップガイド
- Agent Skills、カスタムツール、セッションフック、パーミッションハンドリング、ストリーミング、BYOK
含めないもの:
- TypeScript / .NET SDK の詳細（参考文献 を参照）
- Copilot CLI 単体の使い方ガイド
- 本番運用・スケーリング・インフラ構築の詳細
- GitHub OAuth App 認証フロー（CopilotReportForge ドキュメント を参照）
template_github_copilotパッケージ内部（チュートリアルスクリプトは自己完結）
さらに読む
| ドキュメント | 説明 |
|---|---|
| 概要 | 言語依存しない概念と言語選択 |
| アーキテクチャ | SDK、CLI サーバー、Copilot API の相互作用 |
| はじめに（Python） | Python 固有のセットアップと最初の実行 |
| CLI サーバーモード | Copilot CLI を単独 TCP サーバーとして起動する |
| 参考文献 | API リファレンスと外部リンク |