|
1 | 1 | # Installation |
2 | 2 |
|
| 3 | +## Python virtual environment |
3 | 4 |
|
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: |
5 | 8 | ```bash |
6 | 9 | python -m venv .env |
7 | 10 | ``` |
| 11 | + |
| 12 | +Then activate it: |
8 | 13 | ```bash |
9 | 14 | source .env/bin/activate |
10 | 15 | ``` |
11 | 16 |
|
12 | | -Install SQLMesh using `pip`: |
| 17 | +## Install SQLMesh core |
| 18 | + |
| 19 | +Install the core SQLMesh library with `pip`: |
13 | 20 | ```bash |
14 | 21 | pip install sqlmesh |
15 | 22 | ``` |
16 | 23 |
|
| 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 | + |
17 | 53 | ## Next steps |
18 | 54 | * 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