deltacat

(β˜… 283)

A portable Multimodal Lakehouse powered by Ray that brings exabyte-level scalability and fast, ACID-compliant, change-data-capture to your ML and analytics workloads.

  • .flake8
  • .gitignore
  • .isort.cfg
  • .pre-commit-config.yaml
  • LICENSE
  • Makefile
  • pyproject.toml
  • pytest.ini
  • README-development.md
  • README.md
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/ray-project/deltacat

Downloads the entire project code from GitHub to your computer.

cd deltacat

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
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.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f dev/iceberg-integration/Dockerfile -t deltacat .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 deltacat

Runs the built image as an actual container.

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

3. 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 .

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

jupyter notebook

Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.

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

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation