Require PyArrow in the Python package

Keep the arrow extra available for existing requirements. Update wheel checks and install instructions, and verify that integer packing leaves PyArrow unloaded.
This commit is contained in:
Jan Petykiewicz 2026-11-18 12:36:58 -08:00
commit f474e9848c

View file

@ -6,16 +6,15 @@ Python 3.11 or newer is required.
## Install
To install a PyPI release with Arrow support:
To install a PyPI release:
```sh
python -m pip install 'pheon[arrow]'
python -m pip install pheon
```
For a local wheel, pass its file path followed by `[arrow]` in the same quotes.
Prebuilt wheels bundle the native library. From a source checkout, use
`python -m pip install '.[arrow]'` with Rust 1.88 or newer. The base `pheon`
package is enough for integer packing.
The package installs PyArrow for layout reads. Existing `pheon[arrow]`
requirements still work. Prebuilt wheels bundle the native library. From a
source checkout, use `python -m pip install .` with Rust 1.88 or newer.
Run Python outside the source checkout to use the installed package.
@ -89,7 +88,7 @@ errors use Python's normal I/O exceptions.
## Use from Klamath or Masque
Klamath's `native` extra installs Pheon's packing helpers. Masque's `arrow` extra
installs Pheon with Arrow support. Use the same Python environment as the
installs Pheon for layout reads. Use the same Python environment as the
companion package.
See [development](development.md) to test a locally built native library from