Skip to content

Commit

Permalink
docs(io): update README.md to recommend installing duckdb as default …
Browse files Browse the repository at this point in the history
…backend

Follow up on #5423
xref #5420

This also adds single quotes around bracketed pip install commands to make sure they work with zsh which is the default shell on macOS.
  • Loading branch information
ogrisel authored and cpcloud committed Feb 3, 2023
1 parent 234d8c1 commit 0a72ec0
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ documentation at https://github.com/ibis-project/ibis/blob/master/docs/CONTRIBUT
Install Ibis from PyPI with:

```bash
pip install ibis-framework
pip install 'ibis-framework[duckdb]'
```

Or from conda-forge with:
Expand All @@ -88,13 +88,15 @@ conda install ibis-framework -c conda-forge

(It’s a common mistake to `pip install ibis`. If you try to use Ibis and get errors early on try uninstalling `ibis` and installing `ibis-framework`)

For specific backends, include the backend name in brackets for PyPI:
To discover ibis, we suggest starting with the DuckDB backend (which is included by default in the conda-forge package). The DuckDB backend is performant and fully featured.

To use ibis with other backends, include the backend name in brackets for PyPI:

```bash
pip install ibis-framework[duckdb]
pip install 'ibis-framework[postgres]'
```

Or use `ibis-$BACKEND` where `$BACKEND` the specific backend you want to use:
Or use `ibis-$BACKEND` where `$BACKEND` is the specific backend you want to use when installing from conda-forge:

```bash
conda install ibis-postgres -c conda-forge
Expand Down

0 comments on commit 0a72ec0

Please sign in to comment.