Skip to content

Commit 295e0d2

Browse files
reaperhulkclaudealex
authored
Add AGENTS.md with CLAUDE.md symlink (#14794)
* Add AGENTS.md with CLAUDE.md symlink Document project layout and the canonical commands (nox -e local, uv) for agent-based tooling. Exclude both files from the sdist via check-sdist's git-only list. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Update AGENTS.md Co-authored-by: Alex Gaynor <alex.gaynor@gmail.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Alex Gaynor <alex.gaynor@gmail.com>
1 parent 104a2de commit 295e0d2

3 files changed

Lines changed: 20 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# cryptography
2+
3+
Hybrid Python + Rust project. The Python package lives in `src/cryptography/`; the Rust extension (PyO3) lives in `src/rust/`. CFFI bindings to OpenSSL/BoringSSL/AWS-LC are generated from `src/_cffi_src/`. Test vectors live in `vectors/` (an installable sub-package).
4+
5+
## Running tests
6+
7+
Use `nox -e local` to run the full local check: it formats and lints Python (`ruff`) and Rust (`cargo fmt`/`check`/`clippy`), type-checks with `mypy`, then runs the pytest suite and `cargo test`. This is the canonical command — never invoke `pytest` or `cargo test` directly.
8+
9+
Other useful sessions: `nox -e tests`, `nox -e tests-nocoverage`, `nox -e rust`, `nox -e docs`, `nox -e flake`.
10+
11+
## Package management
12+
13+
Use `uv`, not `pip`, for any Python package installation or environment management. `noxfile.py` already sets `default_venv_backend = "uv"`.
14+
15+
## Changelog
16+
17+
User-visible changes go in `CHANGELOG.rst` under the unreleased section.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,4 +200,6 @@ git-only = [
200200
"ci-constraints-requirements.txt",
201201
".gitattributes",
202202
".gitignore",
203+
"AGENTS.md",
204+
"CLAUDE.md",
203205
]

0 commit comments

Comments
 (0)