sail

(โ˜… 3,322)

Drop-in Apache Spark replacement written in Rust, unifying batch processing, stream processing, and compute-intensive AI workloads.

Showing a partial file list โ€” download the zip above to see everything.

  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .prettierignore
  • Cargo.lock
  • Cargo.toml
  • clippy.toml
  • CODE_OF_CONDUCT.md
  • compose.yml
  • CONTRIBUTING.md
  • eslint.config.js
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pyproject.toml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/lakehq/sail

Downloads the entire project code from GitHub to your computer.

cd sail

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install pysail

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "pyspark-client"

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install pysail

Installs the package published on PyPI directly โ€” no need to clone the source.

pip install "pyspark-client"

Installs the package published on PyPI directly โ€” no need to clone the source.

python -m pysail.examples.spark.compatibility_check <directory>

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation