-
Notifications
You must be signed in to change notification settings - Fork 459
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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: | ||
|
||
 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 :)
There was a problem hiding this comment.
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!