Skip to content

Commit 465df93

Browse files
jeremyederclaude
andcommitted
Replace pip with uv throughout documentation
- Update all package installation commands to use uv - Update CI workflow to install and use uv - Update error messages in scripts to recommend uv - Keep pip only for bootstrapping uv in CI environments Per project standards: always prefer uv over pip for package management. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent fab1d8f commit 465df93

4 files changed

Lines changed: 22 additions & 17 deletions

File tree

.github/workflows/ci.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ jobs:
3535

3636
- name: Install repomap dependencies
3737
run: |
38-
pip install tree-sitter tree-sitter-python tree-sitter-javascript \
39-
tree-sitter-typescript tree-sitter-go tree-sitter-bash
38+
pip install uv
39+
uv pip install tree-sitter tree-sitter-python tree-sitter-javascript \
40+
tree-sitter-typescript tree-sitter-go tree-sitter-bash
4041
4142
- name: Validate repomap is current
4243
run: |

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ git clone https://github.com/ambient-code/reference.git
2727
cd reference
2828

2929
# Install dependencies
30-
pip install -r requirements.txt # Repomap dependencies
31-
pip install -r requirements-dev.txt # Doc tooling
30+
uv pip install -r requirements.txt # Repomap dependencies
31+
uv pip install -r requirements-dev.txt # Doc tooling
3232

3333
# Install pre-commit hooks (includes repomap auto-update)
3434
pre-commit install

docs/patterns/repomap.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This repository includes **complete automation** for repomap management. The rep
1212

1313
```bash
1414
# Install dependencies (includes tree-sitter packages)
15-
pip install -r requirements.txt
15+
uv pip install -r requirements.txt
1616

1717
# Install pre-commit hooks (includes repomap auto-update)
1818
pre-commit install
@@ -36,11 +36,11 @@ pre-commit install
3636
### Install Dependencies
3737

3838
```bash
39-
# Using pip
40-
pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash
41-
42-
# Using uv (recommended)
39+
# Recommended method
4340
uv pip install -r requirements.txt
41+
42+
# Or install individually with uv
43+
uv pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash
4444
```
4545

4646
## Usage
@@ -169,7 +169,9 @@ jobs:
169169
python-version: '3.11'
170170

171171
- name: Install dependencies
172-
run: pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash
172+
run: |
173+
pip install uv
174+
uv pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash
173175
174176
- name: Generate repomap
175177
run: python repomap.py . > repomap.txt
@@ -189,7 +191,8 @@ generate_repomap:
189191
stage: build
190192
image: python:3.11
191193
script:
192-
- pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash
194+
- pip install uv
195+
- uv pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash
193196
- python repomap.py . > repomap.txt
194197
artifacts:
195198
paths:
@@ -237,8 +240,9 @@ repomap-validation:
237240
python-version: '3.11'
238241
- name: Install repomap dependencies
239242
run: |
240-
pip install tree-sitter tree-sitter-python tree-sitter-javascript \
241-
tree-sitter-typescript tree-sitter-go tree-sitter-bash
243+
pip install uv
244+
uv pip install tree-sitter tree-sitter-python tree-sitter-javascript \
245+
tree-sitter-typescript tree-sitter-go tree-sitter-bash
242246
- name: Validate repomap is current
243247
run: ./scripts/update-repomap.sh --check
244248
```
@@ -342,7 +346,7 @@ Potential improvements for future versions:
342346
**Solution**: Install dependencies
343347

344348
```bash
345-
pip install -r requirements.txt
349+
uv pip install -r requirements.txt
346350
```
347351

348352
### Parse Errors
@@ -395,7 +399,7 @@ See LICENSE file in repository root.
395399

396400
**Quickstart**:
397401

398-
1. Install dependencies: `pip install -r requirements.txt`
402+
1. Install dependencies: `uv pip install -r requirements.txt`
399403
2. Install pre-commit hooks: `pre-commit install`
400404
3. The repomap auto-updates on commits!
401405

scripts/update-repomap.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ generate_repomap() {
7373
echo -e "${RED}✗ Failed to generate repository map${NC}" >&2
7474
echo -e "${YELLOW}$error_output${NC}" >&2
7575
if echo "$error_output" | grep -q "tree-sitter packages not installed"; then
76-
echo -e "${YELLOW}Install dependencies: pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash${NC}" >&2
76+
echo -e "${YELLOW}Install dependencies: uv pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash${NC}" >&2
7777
fi
7878
rm -f "${REPOMAP_FILE}.new"
7979
return 1
@@ -97,7 +97,7 @@ check_repomap_current() {
9797
echo -e "${RED}✗ Failed to generate repomap for comparison${NC}" >&2
9898
echo -e "${YELLOW}$error_output${NC}" >&2
9999
if echo "$error_output" | grep -q "tree-sitter packages not installed"; then
100-
echo -e "${YELLOW}Install dependencies: pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash${NC}" >&2
100+
echo -e "${YELLOW}Install dependencies: uv pip install tree-sitter tree-sitter-python tree-sitter-javascript tree-sitter-typescript tree-sitter-go tree-sitter-bash${NC}" >&2
101101
fi
102102
rm -f "${REPOMAP_FILE}.check"
103103
return 1

0 commit comments

Comments
 (0)