Skip to content

Commit 2fef479

Browse files
committed
CMR-11195: readme updates
1 parent d212970 commit 2fef479

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

search-proxy/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ All settings are environment variables with the `CMR_PROXY_` prefix.
3636

3737
| Variable | Default | Description |
3838
|----------|---------|-------------|
39-
| `CMR_PROXY_BACKEND_URL` | required | CMR search base URL (no `/search` suffix) |
40-
| `CMR_PROXY_REDIS_URL` | required | Redis connection URL |
39+
| `CMR_PROXY_BACKEND_URL` | _none — required, startup fails if unset_ | CMR search base URL (no `/search` suffix) |
40+
| `CMR_PROXY_REDIS_URL` | _none — required, startup fails if unset_ | Redis connection URL |
4141
| `CMR_PROXY_LANES_CONFIG` | `lanes.json` | Path to lanes config file; used when `CMR_PROXY_LANES_JSON` is not set |
4242
| `CMR_PROXY_LANES_JSON` || Lanes config as a JSON string; takes precedence over `CMR_PROXY_LANES_CONFIG` when set. Intended for deployments that inject the value from Parameter Store as an environment variable |
4343
| `CMR_PROXY_LOG_LEVEL` | `INFO` | Log level (`DEBUG`, `INFO`, `WARNING`) |
@@ -108,7 +108,14 @@ When a lane is at capacity, `at_capacity` is `true` but `ok?` remains `true`. Us
108108

109109
## Running locally
110110

111+
Requires Python 3.11+ (`pyproject.toml` sets `requires-python = ">=3.11"`).
112+
Deploys run on `python:3.11-slim` and `ruff` targets `py311`, so develop on
113+
3.11 to match — on macOS, `brew install python@3.11`. Use a virtualenv:
114+
111115
```bash
116+
python3.11 -m venv .venv
117+
source .venv/bin/activate
118+
112119
# Install dependencies
113120
pip install -e ".[dev]"
114121

0 commit comments

Comments
 (0)