Skip to content

Python: clarify getting-started environment setup - #9668

Open
LI (ktz03) wants to merge 1 commit into
microsoft:mainfrom
ktz03:docs/python-samples-env-setup-20261024
Open

LI (ktz03) wants to merge 1 commit into
microsoft:mainfrom
ktz03:docs/python-samples-env-setup-20261024

Conversation

@ktz03

Copy link
Copy Markdown
Contributor

Motivation & Context

The Python sample overview tells readers to configure a .env file or FOUNDRY_* environment variables for the getting-started samples. Those samples pass example project_endpoint and model arguments directly to FoundryChatClient, so setting environment variables alone leaves the placeholders in use.

Description & Review Guide

  • What are the major changes? Explain that the example constructor values must be replaced. For environment-based configuration, tell readers to remove the explicit arguments and call load_dotenv() for the Option 1 .env setup. Link the existing getting-started prerequisites.
  • What is the impact of these changes? Documentation only, matching the current samples and client settings behavior. No runtime or API changes.
  • What do you want reviewers to focus on? Consistency with 01-get-started/README.md and the explicit arguments in 01_hello_agent.py. Source and documentation checks were performed; no model calls, SDK build, or product test suite was run.

Related Issue

N/A - trivial change. This corrects setup instructions to match the existing sample and its already-documented configuration procedure; no behavior or design change is proposed.

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: Codex: documentation and this PR description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI balanced review requested due to automatic review settings October 24, 2026 11:51
@ktz03
LI (ktz03) deployed to github-app-auth October 24, 2026 11:51 — with GitHub Actions Active
@ktz03
LI (ktz03) deployed to github-app-auth October 24, 2026 11:51 — with GitHub Actions Active
@agent-framework-automation agent-framework-automation Bot added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python labels Oct 24, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The focused documentation changes match the existing sample configuration behavior, with no unresolved issues.

No open issues 🎉

What changed in this PR

Clarifies environment setup in the Python sample overview to match the getting-started samples’ existing configuration behavior. This is documentation-only, with no runtime or API changes.

Changes:

  • Explains that explicit FoundryChatClient example values must be replaced and override environment variables.
  • Documents removing those arguments for environment-based configuration and calling load_dotenv() when using .env.
  • Links to the getting-started prerequisites.
File Description
python/​samples/​README.md Clarifies constructor overrides and environment-based setup for getting-started samples.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
github-app-auth — a11b1342 Deployed Oct 24, 2026 by ktz03 via team_check #7387
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants