docs: fix install instructions (package not yet on PyPI)#15
Merged
opensource-SantanderAI merged 1 commit intoJun 29, 2026
Merged
Conversation
The README Quick Start recommends `pip install gen-fraud-graph` as the primary install path, but the package is not published to PyPI, so the command fails with "No matching distribution found" in a clean venv. Replace it with the from-source install the project already documents (`uv pip install -e`), add a plain-pip source variant, and add an honest note that the PyPI release is pending. Docs-only, no behaviour change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
All contributors have signed the CLA ✍️ ✅ |
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
Contributor
Author
|
I have read the CLA Document and I hereby sign the CLA |
opensource-SantanderAI
approved these changes
Jun 29, 2026
opensource-SantanderAI
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Accurate docs-only fix: the package isn't on PyPI yet, so 'pip install gen-fraud-graph' fails; the README now leads with the from-source install (uv and plain pip variants) and notes the pending PyPI release. All checks green.
4415bd3
into
SantanderAI:main
11 of 12 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: fix install instructions (package is not on PyPI yet)
Summary
The README's Quick Start tells users to run
pip install gen-fraud-graphas theprimary install path, but that package is not published on PyPI yet, so the command
fails for anyone following the docs. This PR replaces the failing command with the
from-source install path the project already documents (
uv pip install -e), adds aplain-
pipsource variant, and adds an honest note that the PyPI release is stillpending. No code changes.
Reproduction (clean environment)
A fresh virtual environment with only PyPI configured cannot resolve the package:
The same resolution failure via uv:
This is consistent with the repo state:
release.ymlpublishes to PyPI on a GitHubRelease, and no
0.1.0release/tag has been published yet, so there is nodistribution to install.
Changes
README.md: the Installation section now leads with the from-sourceuv pip install -e '.[dev]'path, lists the optional extras (
local,openai,all) as source installs, adds aplain-
pipsource variant, and carries a short note thatpip install gen-fraud-graphwill only work once the package is published. The PyPI badge is left in place (it is
pre-provisioned for the planned release).
CHANGELOG.md: one-line entry under[Unreleased] / Fixed.Notes
CONTRIBUTING.md, this repo requires signing the Santander Contributor LicenseAgreement (CLA) before merge. The CLA Assistant workflow (
.github/workflows/cla.yml)records signatures under
.cla-signatures/. I will sign the CLA when prompted on the PR.