Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
opensource-SantanderAI merged 1 commit into from
Jun 29, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed
- Corrected the README installation section: `pip install gen-fraud-graph` fails because the package is not yet published to PyPI, so the docs now lead with the from-source install (`uv pip install -e`) and note that the PyPI release is pending.

## [0.1.0] - 2026-05-26

### Added
Expand Down
26 changes: 16 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,25 +49,31 @@ The generator creates three types of data:

### Installation

> **Note:** `gen-fraud-graph` is not yet published to PyPI, so `pip install gen-fraud-graph` will fail with `No matching distribution found`. Until the first PyPI release, install from source as shown below. The PyPI badge above is pre-provisioned for the planned release.

Install from source using [uv](https://github.com/astral-sh/uv):
```bash
pip install gen-fraud-graph
git clone https://github.com/SantanderAI/gen-fraud-graph.git
cd gen-fraud-graph
uv venv && source .venv/bin/activate
uv pip install -e '.[dev]'
```

With optional embedding providers:
With optional embedding providers (from the cloned source directory):
```bash
pip install 'gen-fraud-graph[local]' # SentenceTransformers (local model)
pip install 'gen-fraud-graph[openai]' # OpenAI API embeddings
pip install 'gen-fraud-graph[all]' # Everything including dev tools
uv pip install -e '.[local]' # SentenceTransformers (local model)
uv pip install -e '.[openai]' # OpenAI API embeddings
uv pip install -e '.[all]' # Everything including dev tools
```

Or from source using [uv](https://github.com/astral-sh/uv):
If you prefer plain `pip` over `uv`, the source install works the same way:
```bash
git clone https://github.com/SantanderAI/gen-fraud-graph.git
cd gen-fraud-graph
uv venv && source .venv/bin/activate
uv pip install -e '.[dev]'
python -m venv .venv && source .venv/bin/activate
pip install -e '.[dev]'
```

Once the package is published, `pip install gen-fraud-graph` will be the recommended path.

### CLI Usage

```bash
Expand Down
Loading