Skip to content

skills: lead with uv for all Python tooling + SDK on PyPI + AGENTS.md#1741

Open
paulyuk wants to merge 4 commits into
microsoft:mainfrom
paulyuk:docs/sdk-install-and-sandbox-group-cleanup
Open

skills: lead with uv for all Python tooling + SDK on PyPI + AGENTS.md#1741
paulyuk wants to merge 4 commits into
microsoft:mainfrom
paulyuk:docs/sdk-install-and-sandbox-group-cleanup

Conversation

@paulyuk
Copy link
Copy Markdown
Member

@paulyuk paulyuk commented Jun 1, 2026

What

Three related doc changes prepping for prod / release:

1. SDK install: uv pip install azure-containerapps-sandbox

azure-containerapps-sandbox is now on PyPI. Dropped the old curl-and-install-wheel workaround from the Install the Python SDK acceptance-criteria row in plugin/skills/aca-sandboxes/SKILL.md and the matching ## Python SDK — install + use section.

2. Repo-wide policy: lead with uv

New AGENTS.md at the repo root documents the canonical Python tooling for this repo. Hard rules:

  • Lead with uv pip install / uv run / uv venv / uvx.
  • Never lead with bare pip, pip3, python, python3.
  • No "or" branches like uv pip install foo (or pip install foo ). Just the uv form, period.
  • pip / python are acceptable when quoting third-party docs or showing legacy/error output — but never as the recommended command.
  • Pre-PR checklist included.

This file is read by GitHub Copilot CLI, Claude Code, Cursor, and other agents working in the repo.

3. Fix existing instances

  • plugin/skills/aca-sandboxes/SKILL.md — removed the (or uv pip install … ) branch in the cue row; switched the SDK code block from pip install to uv pip install.
  • plugin/skills/aca-sandboxes/references/scenarios.md — Scenario 1 (web app) and Scenario 3 (code interpreter) now invoke uv run /tmp/step.py / uv run /app/server.py instead of python3 ….

--sandbox-group audit (also requested)

Verified every remaining occurrence is legitimate — no stale uses:

Location What it is Verdict
SKILL.md L33–L39 Anti-cue warnings: aca sandbox-group (hyphenated verb) is fabricated; --sandbox-group is the real flag ✅ keep
SKILL.md L67 URL containerapps.azure.com/sandbox-groups ✅ keep
references/quickstart.md Example group name my-sandbox-group ✅ keep
references/reference.md (5 lines) Documents the global --sandbox-group flag — still present in aca --help ✅ keep
scripts/verify-aca-verbs.mjs + scripts/README.md Same anti-cue commentary about the fake verb ✅ keep

Files changed

  • AGENTS.md (new)
  • plugin/skills/aca-sandboxes/SKILL.md
  • plugin/skills/aca-sandboxes/references/scenarios.md

Test

  • aca --help confirms --sandbox-group global flag still exists.
  • uv pip install azure-containerapps-sandbox resolves from PyPI.
  • grep for \bpip3?\s+install and \bpython3?\s+ across plugin/ returns no leading-instruction matches after this change.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

paulyuk and others added 2 commits May 31, 2026 21:34
The azure-containerapps-sandbox SDK has been published to PyPI ahead of
GA. Replace the curl + local-wheel install workaround with the canonical
'pip install azure-containerapps-sandbox' (also works with uv).

The 'Python SDK - install + use' section further down in SKILL.md
already documents the PyPI path; this aligns the cue-row in the
acceptance criteria table with that.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The repo standardizes on 'uv' as the canonical Python tool. Drop
'or pip install' branches and bare 'python3' invocations from skill
docs and scenarios; replace with 'uv pip install' / 'uv run'.

Adds AGENTS.md at the repo root documenting the policy for AI agents
(Copilot CLI, Claude Code, etc.) and human contributors:
- Lead with uv pip install / uv run / uv venv / uvx
- Never lead with pip, pip3, python, python3
- No 'or pip install ...' alternative branches
- Pre-PR checklist

Affected files:
- AGENTS.md (new)
- plugin/skills/aca-sandboxes/SKILL.md: SDK install cue + SDK section
- plugin/skills/aca-sandboxes/references/scenarios.md: web-app +
  code-interpreter sketches now use 'uv run' instead of 'python3'

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@paulyuk paulyuk changed the title docs(aca-sandboxes): SDK is on PyPI — drop wheel-install workaround docs: lead with uv for all Python tooling + SDK on PyPI + AGENTS.md Jun 1, 2026
paulyuk and others added 2 commits May 31, 2026 21:50
Adds the 'check before invoke' preflight pattern to the SDK install
guidance in SKILL.md (both the acceptance-criteria cue row and the
'Python SDK - install + use' section show bash + PowerShell variants),
and adds a corresponding hard rule + checklist item to AGENTS.md.

This closes the gap noted in PR review: previously the docs assumed
'uv' was on PATH and would fail with 'command not found' for users who
don't have it.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…n floor to 3.13+

Adds a new section to AGENTS.md, 'Language runtime versions: recommend
mainstream LTS only', with a per-stack floor table (Python 3.13+,
Node Active LTS, .NET LTS, Go latest two, Java latest LTS), 4 rules
for keeping doc floors honest, and a rationale.

Bumps scripts/region-discovery/README.md from Python 3.12+ to 3.13+
to match. (CI workflow region-discovery.yml still pins 3.12 for now -
that bump should happen in a separate infra PR after testing.)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@paulyuk paulyuk requested a review from annaji-msft June 1, 2026 05:04
@paulyuk paulyuk changed the title docs: lead with uv for all Python tooling + SDK on PyPI + AGENTS.md skills: lead with uv for all Python tooling + SDK on PyPI + AGENTS.md Jun 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants