Skip to content

Commit 649fdf0

Browse files
authored
docs: move all vens to use .venv (#4860)
1 parent 1e04ffe commit 649fdf0

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

docs/guides/projects.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ To create a project from the command line, follow these steps:
2727
1. To scaffold a project, it is recommended that you use a python virtual environment by running the following commands:
2828
2929
```bash
30-
python -m venv .env
30+
python -m venv .venv
3131
```
3232
3333
```bash
34-
source .env/bin/activate
34+
source .venv/bin/activate
3535
```
3636
3737
```bash
3838
pip install sqlmesh
3939
```
4040
41-
**Note:** When using a python virtual environment, you must ensure that it is activated first. You should see `(.env)` in your command line; if you don't, run `source .env/bin/activate` from your project directory to activate your environment.
41+
**Note:** When using a python virtual environment, you must ensure that it is activated first. You should see `(.venv)` in your command line; if you don't, run `source .venv/bin/activate` from your project directory to activate your environment.
4242

4343
1. Once you have activated your environment, run the following command and SQLMesh will build out your project:
4444

docs/guides/ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For development work, we recommend using the SQLMesh UI alongside an IDE. The UI
2424

2525
Before beginning, ensure that you meet all the [prerequisites](../prerequisites.md) for using SQLMesh. The SQLMesh browser UI requires additional Python libraries not included in the base SQLMesh installation.
2626

27-
To use the UI, install SQLMesh with the `web` add-on. First, if using a python virtual environment, ensure it's activated by running `source .env/bin/activate` command from the folder used during [installation](../installation.md).
27+
To use the UI, install SQLMesh with the `web` add-on. First, if using a python virtual environment, ensure it's activated by running `source .venv/bin/activate` command from the folder used during [installation](../installation.md).
2828

2929
Next, install the UI with `pip`:
3030

docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ It is recommended, but not required, that you use a python virtual environment w
88

99
First, create the virtual environment:
1010
```bash
11-
python -m venv .env
11+
python -m venv .venv
1212
```
1313

1414
Then activate it:
1515
```bash
16-
source .env/bin/activate
16+
source .venv/bin/activate
1717
```
1818

1919
## Install SQLMesh core

docs/quickstart/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ mkdir sqlmesh-example
4141
cd sqlmesh-example
4242
```
4343

44-
If using a Python virtual environment, ensure it's activated first by running the `source .env/bin/activate` command from the folder used during [installation](../installation.md).
44+
If using a Python virtual environment, ensure it's activated first by running the `source .venv/bin/activate` command from the folder used during [installation](../installation.md).
4545

4646
### 1.1 Initialize the project
4747

docs/quickstart/notebook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The notebook interface works with both Jupyter and Databricks notebooks. Learn m
3434
## 1. Create the SQLMesh project
3535
First, create a SQLMesh project directory with your operating system's graphical or command-line tools. Next, create a Jupyter or Databricks notebook file - it does not need to be in the SQLMesh project directory.
3636

37-
If using a python virtual environment, ensure it's activated first by running the `source .env/bin/activate` command from the folder used during [installation](../installation.md).
37+
If using a python virtual environment, ensure it's activated first by running the `source .venv/bin/activate` command from the folder used during [installation](../installation.md).
3838

3939
Import the SQLMesh library to load the notebook magic commands:
4040

docs/quickstart/ui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In this quickstart, you'll use the SQLMesh browser user interface to get up and
3131

3232
Before beginning, ensure that you meet all the [prerequisites](../prerequisites.md) for using SQLMesh. The SQLMesh browser UI requires additional Python libraries not included in the base SQLMesh installation.
3333

34-
To use the UI, install SQLMesh with the `web` add-on. First, if using a python virtual environment, ensure it's activated by running `source .env/bin/activate` command from the folder used during [installation](../installation.md).
34+
To use the UI, install SQLMesh with the `web` add-on. First, if using a python virtual environment, ensure it's activated by running `source .venv/bin/activate` command from the folder used during [installation](../installation.md).
3535

3636
Next, install the UI with `pip`:
3737

@@ -52,7 +52,7 @@ Navigate to the directory on the command line:
5252
cd sqlmesh-example
5353
```
5454

55-
If using a python virtual environment, ensure it's activated by running `source .env/bin/activate` from the folder used during [installation](../installation.md).
55+
If using a python virtual environment, ensure it's activated by running `source .venv/bin/activate` from the folder used during [installation](../installation.md).
5656

5757
Create a SQLMesh scaffold with the following command, specifying a default SQL dialect for your models. The dialect should correspond to the dialect most of your models are written in; it can be overridden for specific models in the model's `MODEL` specification. All SQL dialects [supported by the SQLGlot library](https://github.com/tobymao/sqlglot/blob/main/sqlglot/dialects/dialect.py) are allowed.
5858

0 commit comments

Comments
 (0)