Copybara import of the project:

--
5eabc6c1fe339e87637b9ed6d0516a3edcbcb060 by kavinkumarbaskar <kavinkumarbaskar@gmail.com>:

fix readme pip install

--
bb21018aea7a4b8d8a60e6ef42b084dae51d7845 by kavinkumarbaskar <kavinkumarbaskar@gmail.com>:

fix: added build and local testing command

--
aa1f2305b098b79480eab9ab37b744d0273a5fcf by kavinkumarbaskar <kavinkumarbaskar@gmail.com>:

fix: added example

--
69b649d81e6757d6305c481e3415ec8f017a75ac by kavinkumarbaskar <kavinkumarbaskar@gmail.com>:

fix: updated the windows command

--
bd5202308bf08b9b44099c4cd016af23f2e2350e by kavinkumarbaskar <kavinkumarbaskar@gmail.com>:

fix: removed redundant code
COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/529 from kavinkumar807:fix-readme-pip-install a49d82d49a0cecb4cee399620c62ae10c1f3370a
PiperOrigin-RevId: 756122021
This commit is contained in:
Kavin Kumar B 2025-05-07 20:42:23 -07:00 committed by Copybara-Service
parent 7f76af4d76
commit 41564de689

View File

@ -112,7 +112,18 @@ For any changes that impact user-facing documentation (guides, API reference, tu
```shell
python -m venv .venv
```
```shell
source .venv/bin/activate
```
**windows**
```shell
source .\.venv\Scripts\activate
```
```shell
pip install uv
```
@ -131,8 +142,23 @@ For any changes that impact user-facing documentation (guides, API reference, tu
```shell
uv run pyink --config pyproject.toml ./src
```
## Code reviews
6. **Build the package**
```shell
uv build
```
7. **Local Testing**
Have a simple testing folder setup as mentioned in the [quickstart](https://google.github.io/adk-docs/get-started/quickstart/)
then install the local package with changes after building it using the below command to test the changes.
```shell
uv pip install <YOUR_WHL_FILE_PATH>
[eg]: uv pip install <ADK_PROJECT_PATH>/dist/google_adk-0.4.0-py3-none-any.whl
```
### Code reviews
All submissions, including submissions by project members, require review. We
use GitHub pull requests for this purpose. Consult