Setting up a development environment
Required dependencies
Support matrix 1
Python Version | Python 3.9 | Python 3.10 | Python 3.11 |
---|---|---|---|
Operating System | |||
Linux | 2 | ||
macOS (x86_64) | |||
macOS (aarch64) | |||
Windows |
Install Miniconda
Install
gh
conda install -c conda-forge gh
Fork and clone the ibis repository:
gh repo fork --clone --remote ibis-project/ibis
Create a Conda environment using
environment.yml
cd ibis conda env create --file conda/environment.yml
If you’re using arm64 architecture (Mac M1/M2), use
conda/environment-arm64.yml
for setting up a dev environment for all the backends that are possible to install excluding Flink; useconda/environment-arm64-flink.yml
for setting up a dev environment for all the backends that are possible to install including Flink. The reason to have two separate environments is becauseapache-flink
forcespyarrow
to downgrade to 11.0, which causes conflicts in other backends.Activate the environment
conda activate ibis-dev
Install your local copy of
ibis
into the Conda environmentpip install -e .
Install Mamba
Install
gh
mamba install -c conda-forge gh
Fork and clone the ibis repository:
gh repo fork --clone --remote ibis-project/ibis
Create a Conda environment using
environment.yml
cd ibis mamba env create --file conda/environment.yml
If you’re using arm64 architecture (Mac M1/M2), use
conda/environment-arm64.yml
for setting up a dev environment for all the backends that are possible to install excluding Flink; useconda/environment-arm64-flink.yml
for setting up a dev environment for all the backends that are possible to install including Flink. The reason to have two separate environments is becauseapache-flink
forcespyarrow
to downgrade to 11.0, which causes conflicts in other backends.Activate the environment
mamba activate ibis-dev
Install your local copy of
ibis
into the Mamba environmentpip install -e .
Support matrix
Python Version | Python 3.9 | Python 3.10 | Python 3.11 |
---|---|---|---|
Operating System | |||
Linux | 3 | ||
macOS (x86_64) | |||
macOS (arm64/M1/M2) | 4 | 5 | 6 |
Windows | 7 | 8 | 9 |
Configure
nix
Edit/create your
nix.conf
file ($XDG_CONFIG_HOME/nix/nix.conf
) and add the lineexperimental-features = nix-command flakes
Install
gh
:nix-shell -p gh
nix-env -iA gh
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.
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/mamba
or nix
setup instructions.
Fork and clone the ibis repository:
gh repo fork --clone --remote ibis-project/ibis
Change directory into
ibis
:cd ibis
Install development dependencies
pip install 'poetry==1.8.3' pip install -r requirements-dev.txt
Install ibis in development mode
pip install -e .
Code style and formatting
Ibis uses several code linters and has a style guide for documentation, please checkout the style and formatting guide for instructions on how to set things up.
Building the docs
Install just
(if you installed via conda/mamba
you are covered) and run
just docs-preview
to build and serve the documentation.
Footnotes
Some optional dependencies for Windows and Mac OS are not available through
conda
/mamba
↩︎Tested in CI. If this doesn’t work for you, please file an issue.↩︎
Tested in CI. If this doesn’t work for you, please file an issue.↩︎
Not working as of March 2024. See https://github.com/ibis-project/ibis/issues/8696↩︎
Not working as of March 2024. See https://github.com/ibis-project/ibis/issues/8696↩︎
Not working as of March 2024. See https://github.com/ibis-project/ibis/issues/8696↩︎
Unlikely to ever be supported or no upstream support.↩︎
Unlikely to ever be supported or no upstream support.↩︎
Unlikely to ever be supported or no upstream support.↩︎