Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,6 @@ build/

# pytest coverage artifact
.coverage

# Clone-local uv toolchain (see README Prerequisites)
.uv-tool/
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,19 @@ demo, benchmark, and direct exporter calls require an explicit overlay argument.

### Prerequisites

- Python 3.12+
- Python 3.12 to 3.14 (3.15 is not supported yet; pick a supported interpreter, for example `uv python install 3.13`)
- [uv](https://docs.astral.sh/uv/) exactly 0.13.0 for the `make` targets (`make setup`, `make demo`, `make check`). `pyproject.toml` pins `required-version = "==0.13.0"`, so any other uv fails with a version mismatch. Switch with `uv self update 0.13.0`, or install it fresh with `curl -LsSf https://astral.sh/uv/0.13.0/install.sh | sh`. The plain `pip install` paths below do not need uv.

If you would rather not change your global uv, install 0.13.0 inside the clone (nothing is written outside it) and put it first on `PATH` for the session:

```bash
python3 -m venv .uv-tool && .uv-tool/bin/pip install uv==0.13.0
export PATH="$PWD/.uv-tool/bin:$PATH"
uv --version # uv 0.13.0
```

`.uv-tool/` is gitignored. The venv only hosts the uv binary; uv picks its own supported project interpreter (see the Python range above).
- pnpm and Node (versions pinned in `web/`) for `make setup` and `make check`
- A GitHub account (public repos work without a token)
- `GITHUB_TOKEN` env var or `gh` CLI authenticated (for private repos and higher rate limits)

Expand Down Expand Up @@ -233,7 +245,7 @@ output is private operator evidence unless it has been intentionally sanitized.
```bash
git clone https://github.com/saagpatel/GithubRepoAuditor.git
cd GithubRepoAuditor
pip install -e ".[config]"
uv sync --locked --extra config # requires uv 0.13.0, see Prerequisites
make demo
```

Expand Down Expand Up @@ -364,7 +376,7 @@ frontend uses Next.js 15 and React 19 with pinned Node and pnpm toolchains.
JSON, Markdown, HTML, workbooks, and Notion payloads share the audit model.
The canonical local portfolio truth path is `output/portfolio-truth-latest.json`.

For a contributor checkout, run `make setup` and then `make check`. These use
For a contributor checkout, install uv 0.13.0 (see Prerequisites), run `make setup`, then `make check` (this is the test command; Python tests alone: `make check-python`). These use
locked dependencies and offline fixtures; semantic-index checks are a separate
opt-in lane. See [CONTRIBUTING.md](CONTRIBUTING.md) for focused checks.

Expand Down
4 changes: 2 additions & 2 deletions web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"test": "node --experimental-strip-types --test tests/*.test.mjs"
},
"dependencies": {
"next": "^16.4.3",
"next": "^16.4.6",
"react": "^19.3.1",
"react-dom": "^19.3.1"
},
Expand All @@ -21,7 +21,7 @@
"@types/react": "^19.3.0",
"@types/react-dom": "^19.3.0",
"eslint": "9.39.5",
"eslint-config-next": "16.4.3",
"eslint-config-next": "16.4.6",
"typescript": "^6.0.3"
}
}
107 changes: 51 additions & 56 deletions web/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading