Setting up a development environment

Required dependencies

Warning

pip will not handle installation of system dependencies

pip will not install system dependencies needed for some packages such as psycopg2 and kerberos.

For a better development experience see the conda or nix setup instructions.

Fork and clone the ibis repository:

gh repo fork --clone --remote ibis-project/ibis

Install development dependencies

pip install 'poetry==1.7.1'
pip install -r requirements-dev.txt

Note

Some optional dependencies for Windows are not available through conda/mamba

Fork and clone the ibis repository:

gh repo fork --clone --remote ibis-project/ibis

# Create a dev environment for linux-64
cd ibis
conda create -n ibis-dev --file=ci/conda-lock/linux-64/3.10.lock

# Create a dev environment for osx-64
cd ibis
conda create -n ibis-dev --file=ci/conda-lock/osx-64/3.10.lock

# Create a dev environment for osx-arm64
cd ibis
conda create -n ibis-dev --file=ci/conda-lock/osx-arm64/3.10.lock

# Create a dev environment for win-64
cd ibis
conda create -n ibis-dev --file=ci/conda-lock/win-64/3.10.lock

Activate the environment
```
conda activate ibis-dev
```
Install your local copy of ibis into the Conda environment
```
cd ibis
pip install -e '.[all]'
```

Fork and clone the ibis repository:

gh repo fork --clone --remote ibis-project/ibis

# Create a dev environment for linux-64
cd ibis
mamba create -n ibis-dev --file=ci/conda-lock/linux-64/3.10.lock

# Create a dev environment for osx-64
cd ibis
mamba create -n ibis-dev --file=ci/conda-lock/osx-64/3.10.lock

# Create a dev environment for osx-arm64
cd ibis
mamba create -n ibis-dev --file=ci/conda-lock/osx-arm64/3.10.lock

# Create a dev environment for win-64
cd ibis
mamba create -n ibis-dev --file=ci/conda-lock/win-64/3.10.lock

Activate the environment
```
mamba activate ibis-dev
```
Install your local copy of ibis into the Conda environment
```
cd ibis
pip install -e '.[all]'
```

Fork and clone the ibis repository:

gh repo fork --clone --remote ibis-project/ibis

Set up the public ibis Cachix cache to pull pre-built dependencies:
```
nix-shell -p cachix --run 'cachix use ibis'
```
Run nix develop in the checkout directory:
```
cd ibis
nix develop
```
This will launch a bash shell with all of the required dependencies installed. This may take a while due to artifact download from the cache.

Install just and run

just docs-preview

to build and serve the documentation.