Skip to main content

Installation

goosefs is the official Python client for GooseFS. It is implemented in Rust (goosefs-sdk) and bridged via PyO3.

pip install goosefs
Install commandExtra dependenciesUse case
pip install goosefsbinding onlyCore API
pip install 'goosefs[arrow]'+ pyarrowArrow / Parquet
pip install 'goosefs[pandas]'+ pandas + pyarrowDataFrame workflows
pip install 'goosefs[examples]'+ pyarrow + pandasRun all example scripts

Requirements

  • CPython 3.9+ (abi3 wheel)
  • Platforms: Linux x86_64 / aarch64 (manylinux_2_28), macOS x86_64 / arm64, Windows x86_64 (MSVC)
  • A reachable GooseFS Master

Build from Source

cd bindings/python
uv sync --all-extras --group dev --group test
uv run maturin develop --uv
uv run pytest -v

See bindings/python/DEVELOPMENT.md.