Skip to content

Commit bdfbe19

Browse files
AGENTS.md: Check in incremental updates
Assisted-by: Codex
1 parent be3d471 commit bdfbe19

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

AGENTS.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
- Workflow definitions are in `.github/workflows/`; adjust only when CI
1010
requirements change.
1111
- Documentation and contributor notes reside at the repo root (`README.md`,
12-
`AGENTS.md`).
12+
`AGENTS.md`). Automation sessions live in `noxfile.py`; keep shared task logic
13+
there.
1314

1415
## Build, Test, and Development Commands
1516

@@ -19,31 +20,31 @@
1920
pushing.
2021
- `uv run pytest` — execute the suite with the active interpreter.
2122
- `uv build` — produce wheels and sdists identical to the release workflow.
23+
- `uvx nox -s tests` — create matrix virtualenvs via nox and execute the pytest
24+
session.
2225

2326
## Coding Style & Naming Conventions
2427

25-
- Target Python 3.9–3.13; use 4-space indentation and type hints for public
28+
- Target Python 3.10–3.14; use 4-space indentation and type hints for public
2629
APIs.
2730
- Black + isort (via ruff) enforce formatting; run through pre-commit prior to
2831
review.
2932
- Use `snake_case` for functions/modules, `PascalCase` for classes, and
3033
`UPPER_SNAKE_CASE` for constants.
3134
- Prefer `pathlib`, f-strings, and other modern stdlib features—pyupgrade rules
3235
will flag legacy code.
36+
- When calling pdfRest, supply the API key via the `Api-Key` header (not
37+
`Authorization: Bearer`); keep tests and client defaults in sync with this
38+
convention.
3339

3440
## Testing Guidelines
3541

3642
- Write pytest tests: files named `test_*.py`, test functions `test_*`, fixtures
3743
in `conftest.py` where shared.
3844
- Ensure high-value coverage of public functions and edge cases; document intent
3945
in test docstrings when non-obvious.
40-
- For interpreter compatibility, execute the matrix locally:
41-
```bash
42-
for py in 3.9 3.10 3.11 3.12 3.13; do
43-
UV_PROJECT_ENVIRONMENT=.venv-$py uv sync --group dev --python $py
44-
UV_PROJECT_ENVIRONMENT=.venv-$py uv run --python $py pytest
45-
done
46-
```
46+
- Use `uvx nox -s tests` to exercise the full interpreter matrix locally when
47+
validating compatibility.
4748

4849
## Commit & Pull Request Guidelines
4950

@@ -59,8 +60,8 @@
5960
## CI & Publishing Notes
6061

6162
- GitHub Actions run two workflows: `pre-commit` (no AWS credentials) and
62-
`Test and Publish` (Python 3.9–3.13 matrix).
63+
`Test and Publish` (Python 3.10–3.14 matrix).
6364
- Only the release job assumes the AWS OIDC role to `uv build` and publish with
64-
`uv tool run --from twine twine upload`.
65+
`uv publish`.
6566
- Keep CodeArtifact credentials out of source control; day-to-day development
6667
should rely solely on public dependencies.

0 commit comments

Comments
 (0)