Skip to content

docs: fix install instructions (package not yet on PyPI)#15

Merged
opensource-SantanderAI merged 1 commit into
SantanderAI:mainfrom
fabio-rovai:fix-install-docs
Jun 29, 2026
Merged

docs: fix install instructions (package not yet on PyPI)#15
opensource-SantanderAI merged 1 commit into
SantanderAI:mainfrom
fabio-rovai:fix-install-docs

Conversation

@fabio-rovai

Copy link
Copy Markdown
Contributor

docs: fix install instructions (package is not on PyPI yet)

Summary

The README's Quick Start tells users to run pip install gen-fraud-graph as the
primary 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 a
plain-pip source variant, and adds an honest note that the PyPI release is still
pending. No code changes.

Reproduction (clean environment)

A fresh virtual environment with only PyPI configured cannot resolve the package:

$ uv venv --python 3.12 /tmp/clean
$ /tmp/clean/bin/python -m pip install gen-fraud-graph
ERROR: Could not find a version that satisfies the requirement gen-fraud-graph (from versions: none)
ERROR: No matching distribution found for gen-fraud-graph

The same resolution failure via uv:

$ uv pip install gen-fraud-graph
  × No solution found when resolving dependencies:
  ╰─▶ Because gen-fraud-graph was not found in the package registry and you
      require gen-fraud-graph, we can conclude that your requirements are
      unsatisfiable.

This is consistent with the repo state: release.yml publishes to PyPI on a GitHub
Release, and no 0.1.0 release/tag has been published yet, so there is no
distribution to install.

Changes

  • README.md: the Installation section now leads with the from-source uv pip install -e '.[dev]'
    path, lists the optional extras (local, openai, all) as source installs, adds a
    plain-pip source variant, and carries a short note that pip install gen-fraud-graph
    will 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

  • Minimal, docs-only, no behaviour change.
  • Per CONTRIBUTING.md, this repo requires signing the Santander Contributor License
    Agreement (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.

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>
@fabio-rovai fabio-rovai requested a review from a team as a code owner June 23, 2026 20:39
@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@fabio-rovai

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Jun 23, 2026
@fabio-rovai

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@opensource-SantanderAI opensource-SantanderAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@opensource-SantanderAI opensource-SantanderAI merged commit 4415bd3 into SantanderAI:main Jun 29, 2026
11 of 12 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Jun 29, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants