Skip to content

Commit 85d32e5

Browse files
ambvclaude
andcommitted
Document how to update backend dependencies with pip-tools
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 8187e89 commit 85d32e5

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ This project consists of three main components:
1313
## Quick Start
1414

1515
### Prerequisites
16-
- Python 3.8+
17-
- Node.js 16+
18-
- CPython source repository (for benchmarking)
16+
- Docker Engine 20.10+ and Docker Compose 2.0+
17+
- CPython source repository (for benchmarking with the worker)
1918

2019
### Setup & Installation
2120
```bash
@@ -58,6 +57,17 @@ make build # Build frontend for production
5857
make clean # Clean up generated files and caches
5958
```
6059

60+
### Updating Backend Dependencies
61+
```bash
62+
# Edit backend/requirements.in, then regenerate the lockfile:
63+
docker run --rm -v "$(pwd)/backend:/app" -w /app python:3.13-slim-bookworm \
64+
sh -c "pip install --quiet pip-tools && pip-compile --strip-extras \
65+
--generate-hashes --output-file requirements.txt requirements.in"
66+
67+
# Rebuild the backend container:
68+
docker compose -f docker-compose.dev.yml up --build -d backend
69+
```
70+
6171
## Worker Setup
6272

6373
### Worker Usage

docker-README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,24 @@ docker-compose up -d backend
103103

104104
## Development
105105

106+
### Updating Backend Dependencies
107+
108+
Backend dependencies are managed with [pip-tools](https://pip-tools.readthedocs.io/).
109+
Edit `backend/requirements.in` for direct dependencies, then regenerate the
110+
pinned lockfile:
111+
112+
```bash
113+
docker run --rm -v "$(pwd)/backend:/app" -w /app python:3.13-slim-bookworm \
114+
sh -c "pip install --quiet pip-tools && pip-compile --strip-extras \
115+
--generate-hashes --output-file requirements.txt requirements.in"
116+
```
117+
118+
Commit both `requirements.in` and `requirements.txt`, then rebuild:
119+
120+
```bash
121+
docker compose -f docker-compose.dev.yml up --build -d backend
122+
```
123+
106124
### Environment Variables
107125

108126
The application uses a `.env` file for configuration. Copy the example and customize:

0 commit comments

Comments
 (0)