Skip to content

Commit

Permalink
docs(development): move pip to end of env creation tabset
Browse files Browse the repository at this point in the history
Instead of defaulting to `pip` for environment setup, list in order
`conda` -> `nix` -> `pip` since we don't recommend using `pip` for this anyway.
  • Loading branch information
gforsyth committed Mar 5, 2024
1 parent 2cb5caf commit d475660
Showing 1 changed file with 38 additions and 37 deletions.
75 changes: 38 additions & 37 deletions docs/contribute/01_environment.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,43 +18,6 @@ the `conda/mamba` setup and refer to the comment related to `arm64`
architectures.
:::

## pip

::: {.callout-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/mamba` or `nix` setup instructions.
:::

1. [Install `gh`](https://cli.github.com/manual/installation)

1. Fork and clone the ibis repository:

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

1. Change directory into `ibis`:

```sh
cd ibis
```

1. Install development dependencies

```sh
pip install 'poetry==1.8.1'
pip install -r requirements-dev.txt
```

1. Install ibis in development mode

```sh
pip install -e '.[all]'
```

## Conda/Mamba

### Support matrix [^conda-callout]
Expand Down Expand Up @@ -202,6 +165,44 @@ for manager, params in managers.items():
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

::: {.callout-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/mamba` or `nix` setup instructions.
:::

1. [Install `gh`](https://cli.github.com/manual/installation)

1. Fork and clone the ibis repository:

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

1. Change directory into `ibis`:

```sh
cd ibis
```

1. Install development dependencies

```sh
pip install 'poetry==1.8.1'
pip install -r requirements-dev.txt
```

1. Install ibis in development mode

```sh
pip install -e '.[all]'
```

:::

## Building the docs
Expand Down

0 comments on commit d475660

Please sign in to comment.