Skip to content

Commit

Permalink
Add instruction on installing dlt via pixi and conda (#1332)
Browse files Browse the repository at this point in the history
* Add instruction on installing dlt via pixi and conda

* Update getting-started doc

* Add mention to use relevant package managers to install extra dependencies

* Fix typo

* Fix typo

* Update streamlit app screenshot

* Move installation instructions to installation.md

* Add a separate section for pixi and conda
  • Loading branch information
sultaniman authored May 10, 2024
1 parent 025f161 commit 02f5d52
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 3 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,21 @@ Be it a Google Colab notebook, AWS Lambda function, an Airflow DAG, your local l

dlt supports Python 3.8+.

```bash
**pip:**
```sh
pip install dlt
```

**pixi:**
```sh
pixi add dlt
```

**conda:**
```sh
conda install -c conda-forge dlt
```

## Quick Start

Load chess game data from chess.com API and save it in DuckDB:
Expand Down
5 changes: 3 additions & 2 deletions docs/website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Install dlt using `pip`:
pip install -U dlt
```

The command above installs (or upgrades) the library core, in the example below we use DuckDB as a destination so let's add a `duckdb` dependency:
The command above installs (or upgrades) the core library, in the example below we
use DuckDB as a destination so let's add a `duckdb` dependency:

```sh
pip install "dlt[duckdb]"
Expand Down Expand Up @@ -82,7 +83,7 @@ pip install streamlit

Now you should see the **users** table:

![Streamlit Explore data](/img/streamlit1.png)
![Streamlit Explore data](/img/streamlit-new.png)
Streamlit Explore data. Schema and data for a test pipeline “quick_start”.

:::tip
Expand Down
14 changes: 14 additions & 0 deletions docs/website/docs/reference/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,17 @@ You can install `dlt` in your virtual environment by running:
```sh
pip install -U dlt
```

## Install dlt via pixi and conda

Install dlt using `pixi`:

```sh
pixi add dlt
```

Install dlt using `conda`:

```sh
conda install -c conda-forge dlt
```
Binary file added docs/website/static/img/streamlit-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/website/static/img/streamlit1.png
Binary file not shown.

0 comments on commit 02f5d52

Please sign in to comment.