Skip to content

Commit 8a5c7a9

Browse files
authored
fix: align pyproject repo metadata (#38)
## Summary - update the PyPI example README to install from PyPI only - align `python/pyproject.toml` repository URL with `lance-format/lance-context` ## Testing - Not run (docs/metadata changes only)
1 parent cda5d92 commit 8a5c7a9

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

examples/pypi-basic/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Lance Context PyPI Example
22

3-
This example project demonstrates how to install the `lance-context` package from PyPI and work with a context store using the Python API.
3+
This example demonstrates how to install the `lance-context` package from PyPI and work with a context store using the Python API.
44

55
## Setup
66

77
Ensure Python 3.11 or newer is available locally.
8+
This example runs directly from the `src/` directory and only installs `lance-context` from PyPI.
89

910
### Using uv
1011

1112
```bash
1213
cd examples/pypi-basic
1314
uv venv
1415
source .venv/bin/activate
15-
uv pip install -e .
16+
uv pip install lance-context
1617
```
1718

1819
### Using pip
@@ -21,15 +22,13 @@ uv pip install -e .
2122
cd examples/pypi-basic
2223
python -m venv .venv
2324
source .venv/bin/activate
24-
pip install -e .
25+
pip install lance-context
2526
```
2627

2728
## Run the demo
2829

2930
```bash
30-
uv run context-demo
31-
# or
32-
python -m context_example.main
31+
python src/context_example/main.py
3332
```
3433

3534
The script creates a Lance dataset under `.artifacts/` (ignored by git) and appends a short travel-planning conversation. It prints the current version, demonstrates time-travel by checking out an earlier version, and shows how you can reopen the dataset path to continue appending in future runs.

python/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ dependencies = [
1010
description = "Multimodal, versioned context storage for agentic workflows"
1111
authors = [{ name = "Lance Devs", email = "dev@lancedb.com" }]
1212
license = { file = "LICENSE" }
13-
repository = "https://github.com/lancedb/lance-context"
13+
repository = "https://github.com/lance-format/lance-context"
1414
readme = "README.md"
1515
requires-python = ">=3.11,<3.14"
1616
keywords = ["context", "memory", "multimodal", "lance", "agents"]

0 commit comments

Comments
 (0)