@@ -10,9 +10,8 @@ Do not use Redis Stack or other earlier versions of Redis.
1010Get started in a new environment by installing ` uv ` :
1111``` bash
1212pip install uv # Install uv (once)
13- uv venv # Create a virtualenv (once)
14- uv install --all-extras # Install dependencies
15- uv sync --all-extras # Sync latest dependencies
13+ make setup # Create .venv, sync deps, install pre-commit hooks
14+ make sync # Sync latest dependencies
1615```
1716
1817### Activate the virtual environment
@@ -29,14 +28,15 @@ code basepassing to commit.
2928Run all tests like this, including tests that require API keys in the
3029environment:
3130``` bash
32- uv run pytest --run- api-tests
31+ make test- api
3332```
3433
3534### Linting
3635
3736``` bash
38- uv run ruff check # Run linting
39- uv run ruff format # Format code
37+ make pre-commit # Run the exact formatting/lint hooks used in CI
38+ make verify # Run full local verification (pre-commit + API tests)
39+ ```
4040
4141### Managing Dependencies
4242uv add <dependency > # Add a dependency to pyproject.toml and update lock file
@@ -70,8 +70,7 @@ docker-compose down # Stop all services
7070IMPORTANT: This project uses `pre-commit`. You should run `pre-commit`
7171before committing:
7272```bash
73- uv run pre-commit install # Install the hooks first
74- uv run pre-commit run --all-files
73+ make pre-commit
7574```
7675
7776## Important Architectural Patterns
@@ -130,11 +129,11 @@ Always use RedisVL query types for any search operations. This is a project requ
130129
131130The project uses ` pytest ` with ` testcontainers ` for Redis integration testing:
132131
133- - ` uv run pytest ` - Run all tests
134- - ` uv run pytest tests/unit/ ` - Unit tests only
135- - ` uv run pytest tests/integration/ ` - Integration tests (require Redis)
136- - ` uv run pytest -v ` - Verbose output
137- - ` uv run pytest -- cov` - With coverage
132+ - ` make test ` - Run the standard test suite
133+ - ` make test-api ` - Run all tests including API-key-dependent tests
134+ - ` make test-unit ` - Unit tests only
135+ - ` make test-integration ` - Integration tests (require Redis)
136+ - ` make test- cov` - Run tests with coverage
138137
139138## Project Structure
140139
@@ -246,11 +245,11 @@ ENABLE_NER=true
246245## Development Workflow
247246
2482470 . ** Install uv** : ` pip install uv ` to get started with uv
249- 1 . ** Setup** : ` uv install ` to install dependencies
248+ 1 . ** Setup** : ` make setup `
2502492 . ** Redis** : Start Redis Stack via ` docker-compose up redis `
2512503 . ** Development** : Use ` DISABLE_AUTH=true ` for local testing
252- 4 . ** Testing** : Run ` uv run pytest ` before committing
253- 5 . ** Linting** : Pre -commit hooks handle code formatting
251+ 4 . ** Testing** : Run ` make verify ` before committing
252+ 5 . ** Linting** : ` make pre -commit` matches the CI lint gate exactly
2542536 . ** Background Tasks** : Start worker with ` uv run agent-memory task-worker `
255254
256255## Documentation
0 commit comments