-
Notifications
You must be signed in to change notification settings - Fork 419
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
docs: add better installation instructions
Showing
2 changed files
with
44 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.