Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add better installation instructions #1951

Merged
merged 2 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add or replace it with Polars :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ion-elgreco - sure, I added Polars too!

- 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.