Skip to content

Commit 63fad98

Browse files
Document offline installation steps
1 parent 7235ecb commit 63fad98

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,38 @@ python -m pytest -q
101101

102102
---
103103

104+
## 🌐 Offline installation
105+
106+
The source distribution relies on `setuptools` and `wheel` as build-backend
107+
dependencies. When you install in an isolated or air-gapped environment you
108+
must provide those wheels yourself; otherwise the build frontend cannot
109+
bootstrap the backend.
110+
111+
1. On a machine with internet access, download the wheels you need:
112+
113+
```bash
114+
python -m pip download --only-binary=:all: --dest ./wheelhouse \
115+
setuptools>=68 wheel
116+
python -m pip download --only-binary=:all: --dest ./wheelhouse \
117+
kll-sketch
118+
```
119+
120+
2. Transfer the `wheelhouse/` directory to the offline environment.
121+
122+
3. Install using only the local wheels:
123+
124+
```bash
125+
python -m pip install --no-index --find-links ./wheelhouse \
126+
setuptools wheel kll-sketch
127+
```
128+
129+
If you build from a git checkout instead of a released wheel, vendor the
130+
backend wheels somewhere under version control (for example
131+
`tools/vendor/`) and point `PIP_FIND_LINKS` or your installer’s equivalent at
132+
that directory before running `pip install .`.
133+
134+
---
135+
104136
## 📈 Benchmarks
105137

106138
Get the optional tooling with extras:

0 commit comments

Comments
 (0)