mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-23 09:35:13 +00:00
33f544c71d
* Apply permission handler requirements across Copilot SDK docs Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Polish permission update formatting in SDK examples Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Fix review comments on SDK permission handling PR Address 5 review comments from PR #1103: 1. Fix invalid object literal syntax (stray comma) in resumeSession example in copilot-sdk-nodejs.instructions.md 2. Replace unused PermissionHandler import with actual usage in cookbook/copilot-sdk/python/recipe/ralph_loop.py (was using inline lambda instead) 3. Replace unused approveAll import with actual usage in cookbook/copilot-sdk/nodejs/recipe/ralph-loop.ts (was using inline handler instead) 4. Add missing PermissionHandler import to 4 Python code snippets in skills/copilot-sdk/SKILL.md that reference it without importing 5. Add missing approveAll import to 3 TypeScript code snippets in skills/copilot-sdk/SKILL.md that reference it without importing * Refactor session creation to improve code formatting and consistency across SDK examples * Fix formatting: split multi-property lines and put closing braces on own lines Address review comments on PR #1107: - Split OnPermissionRequest + Model onto separate lines in Go, C#, TypeScript - Put closing }); on its own line consistently across all examples - Fix indentation in SKILL.md Quick Start, CLI URL, Error Handling sections - Fix cookbook Go multiple-sessions and error-handling formatting - Fix ralph-loop.md TypeScript indentation --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com>
Runnable Recipe Examples
This folder contains standalone, executable Python examples for each cookbook recipe. Each file can be run directly as a Python script.
Prerequisites
- Python 3.8 or later
- Install dependencies (this installs the SDK from PyPI):
pip install -r requirements.txt
Running Examples
Each .py file is a complete, runnable program with executable permissions:
python <filename>.py
# or on Unix-like systems:
./<filename>.py
Available Recipes
| Recipe | Command | Description |
|---|---|---|
| Error Handling | python error_handling.py |
Demonstrates error handling patterns |
| Multiple Sessions | python multiple_sessions.py |
Manages multiple independent conversations |
| Managing Local Files | python managing_local_files.py |
Organizes files using AI grouping |
| PR Visualization | python pr_visualization.py |
Generates PR age charts |
| Persisting Sessions | python persisting_sessions.py |
Save and resume sessions across restarts |
Examples with Arguments
PR Visualization with specific repo:
python pr_visualization.py --repo github/copilot-sdk
Managing Local Files (edit the file to change target folder):
# Edit the target_folder variable in managing_local_files.py first
python managing_local_files.py
Local SDK Development
The requirements.txt installs the Copilot SDK package from PyPI. This means:
- You get the latest stable release of the SDK
- No need to build from source
- Perfect for using the SDK in your projects
If you want to use a local development version, edit requirements.txt to use -e ../.. for editable mode development.
Python Best Practices
These examples follow Python conventions:
- PEP 8 naming (snake_case for functions and variables)
- Shebang line for direct execution
- Proper exception handling
- Type hints where appropriate
- Standard library usage
Virtual Environment (Recommended)
For isolated development:
# Create virtual environment
python -m venv venv
# Activate it
# Windows:
venv\Scripts\activate
# Unix/macOS:
source venv/bin/activate
# Install dependencies
pip install -r requirements.txt