Skip to content

Commit 52f53fb

Browse files
treyspeakmanrq
andauthored
Docs: add extras to installation docs page (#1370)
* Add extras to installation docs page * format table --------- Co-authored-by: eakmanrq <6326532+eakmanrq@users.noreply.github.com>
1 parent 214b2bc commit 52f53fb

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

docs/installation.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,55 @@
11
# Installation
22

3+
## Python virtual environment
34

4-
It is recommended, but not required, that you use a python virtual environment:
5+
It is recommended, but not required, that you use a python virtual environment with SQLMesh.
6+
7+
First, create the virtual environment:
58
```bash
69
python -m venv .env
710
```
11+
12+
Then activate it:
813
```bash
914
source .env/bin/activate
1015
```
1116

12-
Install SQLMesh using `pip`:
17+
## Install SQLMesh core
18+
19+
Install the core SQLMesh library with `pip`:
1320
```bash
1421
pip install sqlmesh
1522
```
1623

24+
## Install extras
25+
Some SQLMesh functionality requires additional Python libraries. `pip` will automatically install them for you if you specify the relevant name in brackets.
26+
27+
Some extras add features:
28+
29+
| Feature | `pip` command |
30+
|---------------------|---------------------------------|
31+
| Browser UI | `pip install "sqlmesh[web]"` |
32+
| dbt projects | `pip install "sqlmesh[dbt]"` |
33+
| Github CI/CD bot | `pip install "sqlmesh[github]"` |
34+
| Slack notifications | `pip install "sqlmesh[slack]"` |
35+
| Development setup | `pip install "sqlmesh[dev]"` |
36+
| LLM SQL prompt | `pip install "sqlmesh[llm]"` |
37+
38+
Other extras are required to use specific SQL engines:
39+
40+
| SQL engine | `pip` command |
41+
|---------------|--------------------------------------|
42+
| Bigquery | `pip install "sqlmesh[bigquery]"` |
43+
| Databricks | `pip install "sqlmesh[databricks]"` |
44+
| GCP Postgres | `pip install "sqlmesh[gcppostgres]"` |
45+
| MS SQL Server | `pip install "sqlmesh[mssql]"` |
46+
| MySQL | `pip install "sqlmesh[mysql]"` |
47+
| Postgres | `pip install "sqlmesh[postgres]"` |
48+
| Redshift | `pip install "sqlmesh[redshift]"` |
49+
| Snowflake | `pip install "sqlmesh[snowflake]"` |
50+
51+
Multiple extras can be installed at once, as in `pip install "sqlmesh[web,slack]"`.
52+
1753
## Next steps
1854
* Jump right in with the [quickstart example project](quick_start.md).
19-
* Have an existing dbt project? [Check out SQLMesh's dbt adapter](./integrations/dbt.md).
55+
* Have an existing dbt project? Install the dbt extra and [check out SQLMesh's dbt adapter](./integrations/dbt.md).

0 commit comments

Comments
 (0)