PyPI documentation on custom permission handler outdated

[sophiehenning]

The permission kind values listed on https://pypi.org/project/github-copilot-sdk/#permission-handling (subsection "Permission Result Kinds") are outdated. I figured out the new ones from #1146, but it would be great to fix it on PyPI.
Also, adding the information on custom permission handling to https://github.com/github/awesome-copilot/blob/main/instructions/copilot-sdk-python.instructions.md would be very helpful.

[github-actions]

Thanks for reporting this! Here's a summary of the documentation gap:

Documentation Gap

What's missing/incorrect:
The "Permission Result Kinds" section on the [PyPI page for github-copilot-sdk]((pypi.org/redacted) lists outdated permission kind values. The current values were discovered via issue #1146 but haven't been reflected in the published docs.

Additionally, documentation on custom permission handling is absent from the copilot-sdk-python.instructions.md file in the github/awesome-copilot repository.

Affected Files / Pages

1. PyPI README — the permission-handling section of the Python SDK's README (which publishes to PyPI): python/README.md — specifically the "Permission Result Kinds" table/list needs to be updated with current values.
2. awesome-copilot instructions file — instructions/copilot-sdk-python.instructions.md in github/awesome-copilot should include guidance on custom permission handling.

Suggested Improvements

• Update python/README.md to replace the outdated permission kind values with the correct current ones (as clarified in Test harness CLI v1.0.32 incompatible with permission kind values and session.auth from commit dd2dcbc #1146).
• Add a "Custom Permission Handling" section to the Python SDK instructions in awesome-copilot, covering how to register a custom permission handler and what the valid permission result kinds are.

Generated by Documentation Handler for issue #1429 · ● 1.1M · ◷