AGENTS.md file for Codex

This commit is contained in:
Simon Willison 2025-06-03 15:52:09 -07:00 committed by GitHub
parent 12b6ea6977
commit ac0506e15b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

30
AGENTS.md Normal file
View file

@ -0,0 +1,30 @@
# Repository maintenance notes
This project uses a Python virtual environment for development and tests.
## Setting up a development environment
1. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate
```
2. Install the project with its test dependencies:
```bash
pip install -e '.[test]'
```
3. Run the tests:
```bash
pytest
```
## Building the documentation
Run the following commands if you want to build the docs locally:
```bash
cd docs
pip install -r requirements.txt
make html
```