Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add better installation instructions
Browse files Browse the repository at this point in the history
MrPowers committed Dec 8, 2023
1 parent e54996a commit 8a388c5
Showing 2 changed files with 44 additions and 5 deletions.
49 changes: 44 additions & 5 deletions docs/usage/installation.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,56 @@
# Installation

The `deltalake` project can be installed via Pip for Python or Cargo for Rust.
The `deltalake` project can be installed via pip for Python or Cargo for Rust.

## Using Pip
## Install Delta Lake for Python

With pip:

``` bash
pip install deltalake
```

NOTE: official binary wheels are linked against openssl statically for remote objection store communication. Please file Github issue to request for critical openssl upgrade.
With Conda:

```bash
conda install -c conda-forge deltalake
```

## Install Delta Lake for Rust

## Using Cargo
With Cargo:

``` bash
cargo add deltalake
```
```

## Run Delta Lake and pandas in a Jupyter Notebook

You can easily run Delta Lake and pandas in a Jupyter notebook.

Create an environment file with the dependencies as follows:

```yaml
name: deltalake-minimal
channels:
- conda-forge
- defaults
dependencies:
- python=3.11
- ipykernel
- pandas
- jupyterlab
- pip
- pip:
- deltalake
```
Create a virtual environment with the dependencies:
```bash
conda env create -f deltalake-minimal.yml
```

Open the Jupyter notebook and run commands as follows:

![](jupyter-example.png)
Binary file added docs/usage/jupyter-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8a388c5

Please sign in to comment.