From b2d77f7b3b8cf4ec08a517da8ae4a132530d8ade Mon Sep 17 00:00:00 2001 From: Ben King <9087625+benfdking@users.noreply.github.com> Date: Tue, 1 Jul 2025 14:42:52 +0100 Subject: [PATCH] docs: move all vens to use .venv --- docs/guides/projects.md | 6 +++--- docs/guides/ui.md | 2 +- docs/installation.md | 4 ++-- docs/quickstart/cli.md | 2 +- docs/quickstart/notebook.md | 2 +- docs/quickstart/ui.md | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/guides/projects.md b/docs/guides/projects.md index 6101d9eaed..e4dabd76cc 100644 --- a/docs/guides/projects.md +++ b/docs/guides/projects.md @@ -27,18 +27,18 @@ To create a project from the command line, follow these steps: 1. To scaffold a project, it is recommended that you use a python virtual environment by running the following commands: ```bash - python -m venv .env + python -m venv .venv ``` ```bash - source .env/bin/activate + source .venv/bin/activate ``` ```bash pip install sqlmesh ``` - **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. + **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. 1. Once you have activated your environment, run the following command and SQLMesh will build out your project: diff --git a/docs/guides/ui.md b/docs/guides/ui.md index a77d608e77..1da48e50b3 100644 --- a/docs/guides/ui.md +++ b/docs/guides/ui.md @@ -24,7 +24,7 @@ For development work, we recommend using the SQLMesh UI alongside an IDE. The UI 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. -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). +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). Next, install the UI with `pip`: diff --git a/docs/installation.md b/docs/installation.md index aed92c05b6..f12ec566e2 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -8,12 +8,12 @@ It is recommended, but not required, that you use a python virtual environment w First, create the virtual environment: ```bash -python -m venv .env +python -m venv .venv ``` Then activate it: ```bash -source .env/bin/activate +source .venv/bin/activate ``` ## Install SQLMesh core diff --git a/docs/quickstart/cli.md b/docs/quickstart/cli.md index c89da59b75..7b77b2af1e 100644 --- a/docs/quickstart/cli.md +++ b/docs/quickstart/cli.md @@ -41,7 +41,7 @@ mkdir sqlmesh-example cd sqlmesh-example ``` -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). +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). ### 1.1 Initialize the project diff --git a/docs/quickstart/notebook.md b/docs/quickstart/notebook.md index 003a2c741b..a1dae6b822 100644 --- a/docs/quickstart/notebook.md +++ b/docs/quickstart/notebook.md @@ -34,7 +34,7 @@ The notebook interface works with both Jupyter and Databricks notebooks. Learn m ## 1. Create the SQLMesh project 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. -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). +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). Import the SQLMesh library to load the notebook magic commands: diff --git a/docs/quickstart/ui.md b/docs/quickstart/ui.md index af57efcf19..06a9d8c448 100644 --- a/docs/quickstart/ui.md +++ b/docs/quickstart/ui.md @@ -31,7 +31,7 @@ In this quickstart, you'll use the SQLMesh browser user interface to get up and 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. -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). +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). Next, install the UI with `pip`: @@ -52,7 +52,7 @@ Navigate to the directory on the command line: cd sqlmesh-example ``` -If using a python virtual environment, ensure it's activated by running `source .env/bin/activate` from the folder used during [installation](../installation.md). +If using a python virtual environment, ensure it's activated by running `source .venv/bin/activate` from the folder used during [installation](../installation.md). 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.