Skip to content

Update agent docs for uv.lock and verification target #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2025
Merged

Update agent docs for uv.lock and verification target #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@ mypy:
uv run mypy .

.PHONY: tests
tests:
uv run pytest
tests:
uv run pytest

.PHONY: verify
verify: format lint mypy tests

.PHONY: coverage
coverage:
Expand Down
6 changes: 3 additions & 3 deletions agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ In addition, ensure *git*, *curl* and *GNU Make* are on your `PATH`.
├── src/ ← Application code
├── tests/ ← Pytest suite
├── setup.sh ← Environment bootstrap (run once)
├── requirements.lock ← Pinned dependency hashes (uv‑generated)
├── uv.lock ← Pinned dependency hashes (uv‑generated)
└── agents.md ← **You are here**

---
Expand All @@ -35,7 +35,7 @@ In addition, ensure *git*, *curl* and *GNU Make* are on your `PATH`.

1. `./setup.sh` – installs Python 3.12.10 with *pyenv*, creates `.venv`, installs uv, OpenAI Agents SDK 0.0.15, pre‑commit hooks, and Node 22.15.1.
2. `source .venv/bin/activate` – activate the virtual‑env.
3. `make verify` – run formatters, linters, type‑check and tests.
3. `make verify` – runs `format`, `lint`, `mypy` and `tests`.

---

Expand Down Expand Up @@ -90,7 +90,7 @@ Workflow file: `.github/workflows/agents.yml`
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- run: pip install uv==0.7.5 && uv pip install --system -r requirements.lock
- run: pip install uv==0.7.5 && uv pip install --system -r uv.lock
- run: make verify

A separate `deploy.yml` promotes passing revisions to your chosen runtime (e.g. Netlify Functions or AWS Lambda).
Expand Down