agent/agent-framework
1
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Python: Added documentation how to run examples (#605)

Browse Source 
* Added documentation how to run examples

* Small fix

* Update user-documentation-python/getting-started/running_examples.md

Co-authored-by: Tao Chen <taochen@microsoft.com>

* Small fix

---------

Co-authored-by: Tao Chen <taochen@microsoft.com>
This commit is contained in:
Dmytro Struk
2025-09-04 02:24:50 -07:00
committed by GitHub
Unverified
parent 71c047850c
commit 6310ca5be0
2 changed files with 61 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
user-documentation-python/getting-started/README.md
+2
View File
@@ -20,6 +20,8 @@ Make sure to set the following environment variables:
- `FOUNDRY_PROJECT_ENDPOINT`: Your Azure AI Foundry project endpoint
- `FOUNDRY_MODEL_DEPLOYMENT_NAME`: The name of your model deployment
For detailed information about different ways to run examples and configure environment variables, see [Running Examples Guide](running_examples.md).
### Sample Code
```python
user-documentation-python/getting-started/running_examples.md
+59
View File
@@ -0,0 +1,59 @@
# Running Agent Framework Python Examples
This guide explains different ways to run the Agent Framework examples and how to properly configure environment variables for each approach.
## Different Approaches to Running Examples
There are several ways to run the examples, each requiring different environment variable configurations:
### 1. Running within IDE (VS Code with F5)
If you clone the repository and run examples within an IDE like VS Code using F5:
1. Clone the repository:
```bash
git clone https://github.com/microsoft/agent-framework.git
cd agent-framework/python
```
2. Configure environment variables in the `agent-framework/python` folder by creating a `.env` file (use [.env.example](../../python/.env.example) as example):
```
FOUNDRY_PROJECT_ENDPOINT=your_project_endpoint
FOUNDRY_MODEL_DEPLOYMENT_NAME=your_model_deployment_name
```
3. Open the project in VS Code, choose an example and press F5 to run it.
### 2. Running with Terminal Command
If you clone the repository and run samples with `python sample.py` terminal command:
1. Clone the repository and navigate to the specific sample folder:
```bash
git clone https://github.com/microsoft/agent-framework.git
cd agent-framework/python/samples/getting_started/agents/foundry
```
2. Configure environment variables in the sample folder by creating a `.env` file where the sample is located:
```
FOUNDRY_PROJECT_ENDPOINT=your_project_endpoint
FOUNDRY_MODEL_DEPLOYMENT_NAME=your_model_deployment_name
```
3. Run the sample:
```bash
python sample.py
```
### 3. Copy-Paste Code in Local Project
If you copy and paste code samples into your own local project setup:
1. Install the required dependencies in your local environment:
```bash
pip install agent-framework
```
2. Set up environment variables based on your local project configuration (e.g., `.env` file in your project root, system environment variables, or your preferred configuration method).
3. Make sure the environment variables are accessible from where your Python script runs.