From 31db69e259774ffba26ddb909a33d0e6ce5e673c Mon Sep 17 00:00:00 2001 From: =?utf8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Tue, 21 Jul 2026 23:57:21 +0200 Subject: [PATCH] =?utf8?q?=F0=9F=93=9D=20Recommend=20uv=20projects=20by=20?= =?utf8?q?default=20in=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit --- README.md | 7 +- docs/advanced/decimal.md | 2 +- docs/advanced/uuid.md | 2 +- docs/environment-variables.md | 299 +------ docs/index.md | 7 +- docs/install.md | 35 +- docs/tutorial/automatic-id-none-refresh.md | 14 +- docs/tutorial/code-structure.md | 8 +- .../tutorial/connect/create-connected-rows.md | 4 +- .../connect/create-connected-tables.md | 2 +- docs/tutorial/connect/read-connected-data.md | 10 +- .../connect/remove-data-connections.md | 2 +- .../connect/update-data-connections.md | 2 +- .../create-db-and-table-with-db-browser.md | 2 +- docs/tutorial/create-db-and-table.md | 10 +- docs/tutorial/delete.md | 10 +- docs/tutorial/fastapi/simple-hero-api.md | 8 +- docs/tutorial/fastapi/tests.md | 6 +- docs/tutorial/indexes.md | 2 +- docs/tutorial/insert.md | 2 +- docs/tutorial/limit-and-offset.md | 6 +- docs/tutorial/many-to-many/create-data.md | 2 +- .../many-to-many/create-models-with-link.md | 2 +- .../many-to-many/link-with-extra-fields.md | 6 +- .../update-remove-relationships.md | 4 +- docs/tutorial/one.md | 14 +- .../cascade-delete-relationships.md | 10 +- .../read-relationships.md | 2 +- docs/tutorial/update.md | 8 +- docs/tutorial/where.md | 6 +- docs/virtual-environments.md | 831 +----------------- mkdocs.yml | 2 - 32 files changed, 128 insertions(+), 1199 deletions(-) diff --git a/README.md b/README.md index 16ab3f86d..f5864de90 100644 --- a/README.md +++ b/README.md @@ -62,18 +62,19 @@ As **SQLModel** is based on **Pydantic** and **SQLAlchemy**, it requires them. T ## Installation -Make sure you create a [virtual environment](https://sqlmodel.tiangolo.com/virtual-environments/), activate it, and then install SQLModel, for example with: +First, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/), and then add SQLModel to your project:
```console -$ pip install sqlmodel +$ uv add sqlmodel ---> 100% -Successfully installed sqlmodel ```
+If you prefer to use `pip`, install `sqlmodel` inside a virtual environment. See the [installation guide](install.md) for the alternative steps. + ## Example For an introduction to databases, SQL, and everything else, see the [SQLModel documentation](https://sqlmodel.tiangolo.com/databases/). diff --git a/docs/advanced/decimal.md b/docs/advanced/decimal.md index 465fe8bea..02b84ab8b 100644 --- a/docs/advanced/decimal.md +++ b/docs/advanced/decimal.md @@ -82,7 +82,7 @@ Now if you run this, instead of printing the unexpected number `3.30000000000000
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 diff --git a/docs/advanced/uuid.md b/docs/advanced/uuid.md index ff90c0bf7..833ced4b7 100644 --- a/docs/advanced/uuid.md +++ b/docs/advanced/uuid.md @@ -127,7 +127,7 @@ If you run the program, you will see the **UUID** generated in the Python code,
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 diff --git a/docs/environment-variables.md b/docs/environment-variables.md index 4d5a6983e..d64f41a87 100644 --- a/docs/environment-variables.md +++ b/docs/environment-variables.md @@ -1,300 +1,9 @@ # Environment Variables -Before we jump into code, let's cover a bit some of the **basics** that we'll need to understand how to work with Python (and programming) in general. Let's check a bit about **environment variables**. +An **environment variable** (also known as an **env var**) is a value that lives outside of your Python code, in the operating system, and can be read by your application and other programs. -/// tip +Applications commonly use environment variables for configuration such as database URLs, credentials, and secret keys. -If you already know what "environment variables" are and how to use them, feel free to skip this. +## Learn More { #learn-more } -/// - -An environment variable (also known as "**env var**") is a variable that lives **outside** of the Python code, in the **operating system**, and could be read by your Python code (or by other programs as well). - -Environment variables could be useful for handling application **settings**, as part of the **installation** of Python, etc. - -## Create and Use Env Vars - -You can **create** and use environment variables in the **shell (terminal)**, without needing Python: - -//// tab | Linux, macOS, Windows Bash - -
- -```console -// You could create an env var MY_NAME with -$ export MY_NAME="Wade Wilson" - -// Then you could use it with other programs, like -$ echo "Hello $MY_NAME" - -Hello Wade Wilson -``` - -
- -//// - -//// tab | Windows PowerShell - -
- -```console -// Create an env var MY_NAME -$ $Env:MY_NAME = "Wade Wilson" - -// Use it with other programs, like -$ echo "Hello $Env:MY_NAME" - -Hello Wade Wilson -``` - -
- -//// - -## Read env vars in Python - -You could also create environment variables **outside** of Python, in the terminal (or with any other method), and then **read them in Python**. - -For example you could have a file `main.py` with: - -```Python hl_lines="3" -import os - -name = os.getenv("MY_NAME", "World") -print(f"Hello {name} from Python") -``` - -/// tip - -The second argument to [`os.getenv()`](https://docs.python.org/3.8/library/os.html#os.getenv) is the default value to return. - -If not provided, it's `None` by default, here we provide `"World"` as the default value to use. - -/// - -Then you could call that Python program: - -//// tab | Linux, macOS, Windows Bash - -
- -```console -// Here we don't set the env var yet -$ python main.py - -// As we didn't set the env var, we get the default value - -Hello World from Python - -// But if we create an environment variable first -$ export MY_NAME="Wade Wilson" - -// And then call the program again -$ python main.py - -// Now it can read the environment variable - -Hello Wade Wilson from Python -``` - -
- -//// - -//// tab | Windows PowerShell - -
- -```console -// Here we don't set the env var yet -$ python main.py - -// As we didn't set the env var, we get the default value - -Hello World from Python - -// But if we create an environment variable first -$ $Env:MY_NAME = "Wade Wilson" - -// And then call the program again -$ python main.py - -// Now it can read the environment variable - -Hello Wade Wilson from Python -``` - -
- -//// - -As environment variables can be set outside of the code, but can be read by the code, and don't have to be stored (committed to `git`) with the rest of the files, it's common to use them for configurations or **settings**. - -You can also create an environment variable only for a **specific program invocation**, that is only available to that program, and only for its duration. - -To do that, create it right before the program itself, on the same line: - -
- -```console -// Create an env var MY_NAME in line for this program call -$ MY_NAME="Wade Wilson" python main.py - -// Now it can read the environment variable - -Hello Wade Wilson from Python - -// The env var no longer exists afterwards -$ python main.py - -Hello World from Python -``` - -
- -/// tip - -You can read more about it at [The Twelve-Factor App: Config](https://12factor.net/config). - -/// - -## Types and Validation - -These environment variables can only handle **text strings**, as they are external to Python and have to be compatible with other programs and the rest of the system (and even with different operating systems, as Linux, Windows, macOS). - -That means that **any value** read in Python from an environment variable **will be a `str`**, and any conversion to a different type or any validation has to be done in code. - -## `PATH` Environment Variable - -There is a **special** environment variable called **`PATH`** that is used by the operating systems (Linux, macOS, Windows) to find programs to run. - -The value of the variable `PATH` is a long string that is made of directories separated by a colon `:` on Linux and macOS, and by a semicolon `;` on Windows. - -For example, the `PATH` environment variable could look like this: - -//// tab | Linux, macOS - -```plaintext -/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin -``` - -This means that the system should look for programs in the directories: - -* `/usr/local/bin` -* `/usr/bin` -* `/bin` -* `/usr/sbin` -* `/sbin` - -//// - -//// tab | Windows - -```plaintext -C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32 -``` - -This means that the system should look for programs in the directories: - -* `C:\Program Files\Python312\Scripts` -* `C:\Program Files\Python312` -* `C:\Windows\System32` - -//// - -When you type a **command** in the terminal, the operating system **looks for** the program in **each of those directories** listed in the `PATH` environment variable. - -For example, when you type `python` in the terminal, the operating system looks for a program called `python` in the **first directory** in that list. - -If it finds it, then it will **use it**. Otherwise it keeps looking in the **other directories**. - -### Installing Python and Updating the `PATH` - -When you install Python, you might be asked if you want to update the `PATH` environment variable. - -//// tab | Linux, macOS - -Let's say you install Python and it ends up in a directory `/opt/custompython/bin`. - -If you say yes to update the `PATH` environment variable, then the installer will add `/opt/custompython/bin` to the `PATH` environment variable. - -It could look like this: - -```plaintext -/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/opt/custompython/bin -``` - -This way, when you type `python` in the terminal, the system will find the Python program in `/opt/custompython/bin` (the last directory) and use that one. - -//// - -//// tab | Windows - -Let's say you install Python and it ends up in a directory `C:\opt\custompython\bin`. - -If you say yes to update the `PATH` environment variable, then the installer will add `C:\opt\custompython\bin` to the `PATH` environment variable. - -```plaintext -C:\Program Files\Python312\Scripts;C:\Program Files\Python312;C:\Windows\System32;C:\opt\custompython\bin -``` - -This way, when you type `python` in the terminal, the system will find the Python program in `C:\opt\custompython\bin` (the last directory) and use that one. - -//// - -This way, when you type `python` in the terminal, the system will find the Python program in `/opt/custompython/bin` (the last directory) and use that one. - -So, if you type: - -
- -```console -$ python -``` - -
- -//// tab | Linux, macOS - -The system will **find** the `python` program in `/opt/custompython/bin` and run it. - -It would be roughly equivalent to typing: - -
- -```console -$ /opt/custompython/bin/python -``` - -
- -//// - -//// tab | Windows - -The system will **find** the `python` program in `C:\opt\custompython\bin\python` and run it. - -It would be roughly equivalent to typing: - -
- -```console -$ C:\opt\custompython\bin\python -``` - -
- -//// - -This information will be useful when learning about [Virtual Environments](virtual-environments.md). - -## Conclusion - -With this you should have a basic understanding of what **environment variables** are and how to use them in Python. - -You can also read more about them in the [Wikipedia for Environment Variable](https://en.wikipedia.org/wiki/Environment_variable). - -In many cases it's not very obvious how environment variables would be useful and applicable right away. But they keep showing up in many different scenarios when you are developing, so it's good to know about them. - -For example, you will need this information in the next section, about [Virtual Environments](virtual-environments.md). +Read the [Environment Variables guide](https://tiangolo.com/guides/environment-variables/) for a detailed, cross-platform explanation, including how to create and read environment variables and how the `PATH` environment variable works. diff --git a/docs/index.md b/docs/index.md index 78009abef..3114f5bc2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -82,18 +82,19 @@ As **SQLModel** is based on **Pydantic** and **SQLAlchemy**, it requires them. T ## Installation -Make sure you create a [virtual environment](https://sqlmodel.tiangolo.com/virtual-environments/), activate it, and then install SQLModel, for example with: +First, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/), and then add SQLModel to your project:
```console -$ pip install sqlmodel +$ uv add sqlmodel ---> 100% -Successfully installed sqlmodel ```
+If you prefer to use `pip`, install `sqlmodel` inside a virtual environment. See the [installation guide](install.md) for the alternative steps. + ## Example For an introduction to databases, SQL, and everything else, see the [SQLModel documentation](https://sqlmodel.tiangolo.com/databases/). diff --git a/docs/install.md b/docs/install.md index 048c3c643..0d1a128ea 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,19 +1,48 @@ # Install **SQLModel** -Create a project directory, create a [virtual environment](virtual-environments.md), activate it, and then install **SQLModel**, for example with: +The first step is to set up your project and add **SQLModel**. + +Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/), then create a project and add SQLModel:
```console -$ pip install sqlmodel +$ uv init awesome-project --bare +$ cd awesome-project +$ uv add sqlmodel ---> 100% -Successfully installed sqlmodel pydantic sqlalchemy ```
+`uv add` creates the project's virtual environment in `.venv`, adds SQLModel to `pyproject.toml`, and creates `uv.lock` so the same package versions can be installed later. + +/// details | What these commands do + +* `uv init`: create a new Python project. +* `awesome-project`: create the project in a new directory with this name. +* `--bare`: create only the minimal `pyproject.toml` file, without generating a sample `main.py`, `README.md`, or other files. You will create the application files yourself in the next steps of this tutorial. + +Then `cd awesome-project` enters the new project directory before adding SQLModel. + +`uv` will use a compatible Python version already installed on your system, or download one if needed. + +When you run `uv add`, it selects compatible versions of SQLModel and all the packages SQLModel depends on. It records the exact versions in `uv.lock`, making it possible to install the same package versions later on another computer or when deploying the application. + +Creating or updating this file is called [**locking** the project dependencies](https://docs.astral.sh/uv/concepts/projects/sync/). `uv` does this automatically when you add a package. + +/// + As **SQLModel** is built on top of [SQLAlchemy](https://www.sqlalchemy.org/) and [Pydantic](https://pydantic-docs.helpmanual.io/), when you install `sqlmodel` they will also be automatically installed. +/// details | Using `pip` instead + +If you prefer to manage a virtual environment and packages manually, create and activate a virtual environment and then install SQLModel with `pip install sqlmodel`. + +Read the [Virtual Environments guide](https://tiangolo.com/guides/virtual-environments/) for the detailed steps. + +/// + ## Install DB Browser for SQLite Remember that [SQLite is a simple database in a single file](databases.md#a-single-file-database)? diff --git a/docs/tutorial/automatic-id-none-refresh.md b/docs/tutorial/automatic-id-none-refresh.md index c55951f4e..5687f2b42 100644 --- a/docs/tutorial/automatic-id-none-refresh.md +++ b/docs/tutorial/automatic-id-none-refresh.md @@ -51,7 +51,7 @@ That will output:
```console -$ python app.py +$ uv run python app.py // Output above omitted 👆 @@ -82,7 +82,7 @@ This will, again, output the `id`s of the objects as `None`:
```console -$ python app.py +$ uv run python app.py // Output above omitted 👆 @@ -107,7 +107,7 @@ And now, something unexpected happens, look at the output, it seems as if the `H
```console -$ python app.py +$ uv run python app.py // Output above omitted 👆 @@ -179,7 +179,7 @@ Let's see how it works:
```console -$ python app.py +$ uv run python app.py // Output above omitted 👆 @@ -254,7 +254,7 @@ Here's how the output would look like:
```console -$ python app.py +$ uv run python app.py // Output above omitted 👆 @@ -304,7 +304,7 @@ And the output shows again the same data:
```console -$ python app.py +$ uv run python app.py // Output above omitted 👆 @@ -347,7 +347,7 @@ And here's all the output generated by running this program, all together:
```console -$ python app.py +$ uv run python app.py INFO Engine BEGIN (implicit) INFO Engine PRAGMA main.table_info("hero") diff --git a/docs/tutorial/code-structure.md b/docs/tutorial/code-structure.md index 4b879ed7e..e9ad77f9f 100644 --- a/docs/tutorial/code-structure.md +++ b/docs/tutorial/code-structure.md @@ -102,13 +102,13 @@ We are doing that here, we import the models in `app.py` and **after** that we c Because now this is a larger project with a **Python package** and not a single Python file, we **cannot** call it just passing a single file name as we did before with: ```console -$ python app.py +$ uv run python app.py ``` Now we have to tell Python that we want it to execute a *module* that is part of a package: ```console -$ python -m project.app +$ uv run python -m project.app ``` The `-m` is to tell Python to call a *module*. And the next thing we pass is a string with `project.app`, that is the same format we would use in an **import**: @@ -129,7 +129,7 @@ So, the output would be:
```console -$ python -m project.app +$ uv run python -m project.app Created hero: id=1 secret_name='Dive Wilson' team_id=1 name='Deadpond' age=None Hero's team: name='Z-Force' headquarters='Sister Margaret's Bar' id=1 @@ -228,7 +228,7 @@ And running that achieves the same result as before:
```console -$ python -m project.app +$ uv run python -m project.app Created hero: id=1 age=None name='Deadpond' secret_name='Dive Wilson' team_id=1 Hero's team: id=1 name='Z-Force' headquarters='Sister Margaret's Bar' diff --git a/docs/tutorial/connect/create-connected-rows.md b/docs/tutorial/connect/create-connected-rows.md index 230921054..ffcfd0a78 100644 --- a/docs/tutorial/connect/create-connected-rows.md +++ b/docs/tutorial/connect/create-connected-rows.md @@ -82,7 +82,7 @@ If we run that code we have up to now, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 @@ -168,7 +168,7 @@ If we execute that in the command line, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 diff --git a/docs/tutorial/connect/create-connected-tables.md b/docs/tutorial/connect/create-connected-tables.md index 14fc3c925..d1703f32b 100644 --- a/docs/tutorial/connect/create-connected-tables.md +++ b/docs/tutorial/connect/create-connected-tables.md @@ -129,7 +129,7 @@ If we run the code we have up to now, it will go and create the database file `d
```console -$ python app.py +$ uv run python app.py // Automatically start a new transaction INFO Engine BEGIN (implicit) diff --git a/docs/tutorial/connect/read-connected-data.md b/docs/tutorial/connect/read-connected-data.md index 7db237148..7432b4702 100644 --- a/docs/tutorial/connect/read-connected-data.md +++ b/docs/tutorial/connect/read-connected-data.md @@ -154,7 +154,7 @@ Now we can run the program and see how it shows us each hero with their correspo
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 @@ -262,7 +262,7 @@ And if we run it in the command line, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 @@ -385,7 +385,7 @@ And if we run it, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 @@ -436,7 +436,7 @@ If we run that, it would output:
```console -$ python app.py +$ uv run python app.py // Select only the hero data INFO Engine SELECT hero.id, hero.name, hero.secret_name, hero.age, hero.team_id @@ -463,7 +463,7 @@ And if we run that, it will output:
```console -$ python app.py +$ uv run python app.py // Select the hero and the team data INFO Engine SELECT hero.id, hero.name, hero.secret_name, hero.age, hero.team_id, team.id AS id_1, team.name AS name_1, team.headquarters diff --git a/docs/tutorial/connect/remove-data-connections.md b/docs/tutorial/connect/remove-data-connections.md index d0a0267b1..d133b19cb 100644 --- a/docs/tutorial/connect/remove-data-connections.md +++ b/docs/tutorial/connect/remove-data-connections.md @@ -56,7 +56,7 @@ Running that in the command line will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 diff --git a/docs/tutorial/connect/update-data-connections.md b/docs/tutorial/connect/update-data-connections.md index 147c4e599..cdce7720f 100644 --- a/docs/tutorial/connect/update-data-connections.md +++ b/docs/tutorial/connect/update-data-connections.md @@ -56,7 +56,7 @@ Running that in the command line will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 😉 diff --git a/docs/tutorial/create-db-and-table-with-db-browser.md b/docs/tutorial/create-db-and-table-with-db-browser.md index 8b3bf93a1..508110bea 100644 --- a/docs/tutorial/create-db-and-table-with-db-browser.md +++ b/docs/tutorial/create-db-and-table-with-db-browser.md @@ -40,7 +40,7 @@ Click the button New Database. -A dialog should show up. Go to the [project directory you created](../virtual-environments.md#create-a-project) and save the file with a name of `database.db`. +A dialog should show up. Go to your project directory and save the file with a name of `database.db`. /// tip diff --git a/docs/tutorial/create-db-and-table.md b/docs/tutorial/create-db-and-table.md index a7cd9e3f6..40a9c4e1b 100644 --- a/docs/tutorial/create-db-and-table.md +++ b/docs/tutorial/create-db-and-table.md @@ -2,7 +2,7 @@ Now let's get to the code. 👩‍💻 -Make sure you are inside of your project directory and with your virtual environment activated as explained in [Virtual Environments](../virtual-environments.md#create-a-project). +Make sure you are inside of your project directory. We will: @@ -327,7 +327,7 @@ Put the code in a file `app.py` if you haven't already. /// tip -Remember to [activate the virtual environment](../virtual-environments.md#create-a-virtual-environment) before running it. +Run it inside the project environment with `uv run`. /// @@ -337,7 +337,7 @@ Now run the program with Python: ```console // We set echo=True, so this will show the SQL code -$ python app.py +$ uv run python app.py // First, some boilerplate SQL that we are not that interested in @@ -467,7 +467,7 @@ The main purpose of the `__name__ == "__main__"` is to have some code that is ex
```console -$ python app.py +$ uv run python app.py // Something happens here ✨ ``` @@ -497,7 +497,7 @@ If you run it with:
```console -$ python myapp.py +$ uv run python myapp.py // This will call create_db_and_tables() ``` diff --git a/docs/tutorial/delete.md b/docs/tutorial/delete.md index f6807fdda..87f70e771 100644 --- a/docs/tutorial/delete.md +++ b/docs/tutorial/delete.md @@ -67,7 +67,7 @@ That will print the same existing hero **Spider-Youngster**:
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 @@ -105,7 +105,7 @@ This commit after deleting the hero will generate this output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -138,7 +138,7 @@ This will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -167,7 +167,7 @@ This will execute some SQL in the database and output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -198,7 +198,7 @@ This will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 diff --git a/docs/tutorial/fastapi/simple-hero-api.md b/docs/tutorial/fastapi/simple-hero-api.md index fae34a346..569f34643 100644 --- a/docs/tutorial/fastapi/simple-hero-api.md +++ b/docs/tutorial/fastapi/simple-hero-api.md @@ -8,12 +8,12 @@ The first step is to install FastAPI. FastAPI is the framework to create the **web API**. -Make sure you create a [virtual environment](../../virtual-environments.md), activate it, and then install them, for example with: +Add them to your project:
```console -$ pip install fastapi "uvicorn[standard]" +$ uv add fastapi "uvicorn[standard]" ---> 100% ``` @@ -145,7 +145,7 @@ Then run it with the `fastapi` CLI,
```console -$ fastapi dev main.py +$ uv run fastapi dev main.py INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) ``` @@ -169,7 +169,7 @@ For production, use `fastapi run` instead of `fastapi dev`:
```console -$ fastapi run main.py +$ uv run fastapi run main.py INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit) ``` diff --git a/docs/tutorial/fastapi/tests.md b/docs/tutorial/fastapi/tests.md index c7b2d7f34..b43089c36 100644 --- a/docs/tutorial/fastapi/tests.md +++ b/docs/tutorial/fastapi/tests.md @@ -36,12 +36,12 @@ If you haven't done testing in FastAPI applications, first check the [FastAPI do Then, we can continue here, the first step is to install the dependencies, `requests` and `pytest`. -Make sure you create a [virtual environment](../../virtual-environments.md), activate it, and then install them, for example with: +Add them to your project:
```console -$ pip install requests pytest +$ uv add requests pytest ---> 100% ``` @@ -353,7 +353,7 @@ Now we can run the tests with `pytest` and see the results:
```console -$ pytest +$ uv run pytest ============= test session starts ============== platform linux -- Python 3.10.0, pytest-7.4.4, pluggy-1.5.0 diff --git a/docs/tutorial/indexes.md b/docs/tutorial/indexes.md index 857938469..45a74a40c 100644 --- a/docs/tutorial/indexes.md +++ b/docs/tutorial/indexes.md @@ -294,7 +294,7 @@ If you run the program now, you will see an output like this:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 diff --git a/docs/tutorial/insert.md b/docs/tutorial/insert.md index 82a222902..93028518f 100644 --- a/docs/tutorial/insert.md +++ b/docs/tutorial/insert.md @@ -251,7 +251,7 @@ Because we created the **engine** with `echo=True`, it will print out all the SQ
```console -$ python app.py +$ uv run python app.py // Some boilerplate, checking that the hero table already exists INFO Engine BEGIN (implicit) INFO Engine PRAGMA main.table_info("hero") diff --git a/docs/tutorial/limit-and-offset.md b/docs/tutorial/limit-and-offset.md index 90bb167f2..97c9d1dec 100644 --- a/docs/tutorial/limit-and-offset.md +++ b/docs/tutorial/limit-and-offset.md @@ -43,7 +43,7 @@ If we run it on the command line, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 @@ -147,7 +147,7 @@ And if we run it in the command line, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 @@ -196,7 +196,7 @@ But we are starting to include after an offset of 1 (so we don't count the first
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 diff --git a/docs/tutorial/many-to-many/create-data.md b/docs/tutorial/many-to-many/create-data.md index 3c8c0cfa6..e434895bf 100644 --- a/docs/tutorial/many-to-many/create-data.md +++ b/docs/tutorial/many-to-many/create-data.md @@ -43,7 +43,7 @@ If we run the program from the command line, it would output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 diff --git a/docs/tutorial/many-to-many/create-models-with-link.md b/docs/tutorial/many-to-many/create-models-with-link.md index af6563e1a..982247420 100644 --- a/docs/tutorial/many-to-many/create-models-with-link.md +++ b/docs/tutorial/many-to-many/create-models-with-link.md @@ -71,7 +71,7 @@ If you run the code in the command line, it would output:
```console -$ python app.py +$ uv run python app.py // Boilerplate omitted 😉 diff --git a/docs/tutorial/many-to-many/link-with-extra-fields.md b/docs/tutorial/many-to-many/link-with-extra-fields.md index 8e7d9de08..f6fb8f544 100644 --- a/docs/tutorial/many-to-many/link-with-extra-fields.md +++ b/docs/tutorial/many-to-many/link-with-extra-fields.md @@ -80,7 +80,7 @@ Now, if we run the program, it will show almost the same output as before, becau
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 @@ -176,7 +176,7 @@ If we run that program, we will see the output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 @@ -257,7 +257,7 @@ And if we run the program now, it will output:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 diff --git a/docs/tutorial/many-to-many/update-remove-relationships.md b/docs/tutorial/many-to-many/update-remove-relationships.md index ebc9ba3a8..116ba223a 100644 --- a/docs/tutorial/many-to-many/update-remove-relationships.md +++ b/docs/tutorial/many-to-many/update-remove-relationships.md @@ -53,7 +53,7 @@ You can confirm it's all working by running the program in the command line:
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 @@ -130,7 +130,7 @@ To confirm that this last part worked, you can run the program again, it will ou
```console -$ python app.py +$ uv run python app.py // Previous output omitted 🙈 diff --git a/docs/tutorial/one.md b/docs/tutorial/one.md index 63e6a9e44..733d2a5e2 100644 --- a/docs/tutorial/one.md +++ b/docs/tutorial/one.md @@ -47,7 +47,7 @@ If we run it in the command line it would output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -78,7 +78,7 @@ When we run it in the command line it will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -111,7 +111,7 @@ If we run it once, it will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -134,7 +134,7 @@ So, running it again, without first deleting the file `database.db` will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -175,7 +175,7 @@ This is what we would get if we run it in the command line:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -226,7 +226,7 @@ If you run it, it will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -253,7 +253,7 @@ Running that will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 diff --git a/docs/tutorial/relationship-attributes/cascade-delete-relationships.md b/docs/tutorial/relationship-attributes/cascade-delete-relationships.md index 1e31828c7..e3ff59bac 100644 --- a/docs/tutorial/relationship-attributes/cascade-delete-relationships.md +++ b/docs/tutorial/relationship-attributes/cascade-delete-relationships.md @@ -236,7 +236,7 @@ We can confirm everything is working by running the program.
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 @@ -378,7 +378,7 @@ Let's confirm it all works by running the program now:
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 @@ -461,7 +461,7 @@ Now, if we run the program, we will see that SQLModel (SQLAlchemy) is no longer
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 @@ -539,7 +539,7 @@ Now, if we run the program and try to delete a team with heroes, we will see an
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 @@ -602,7 +602,7 @@ Now, if we run the program and delete the heroes first, we will be able to delet
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 diff --git a/docs/tutorial/relationship-attributes/read-relationships.md b/docs/tutorial/relationship-attributes/read-relationships.md index 528c0c983..aa783f45d 100644 --- a/docs/tutorial/relationship-attributes/read-relationships.md +++ b/docs/tutorial/relationship-attributes/read-relationships.md @@ -43,7 +43,7 @@ That would print a list with all the heroes in the Preventers team:
```console -$ python app.py +$ uv run python app.py // Automatically fetch the heroes INFO Engine SELECT hero.id AS hero_id, hero.name AS hero_name, hero.secret_name AS hero_secret_name, hero.age AS hero_age, hero.team_id AS hero_team_id diff --git a/docs/tutorial/update.md b/docs/tutorial/update.md index 55af9c94d..af7a8ec13 100644 --- a/docs/tutorial/update.md +++ b/docs/tutorial/update.md @@ -98,7 +98,7 @@ Up to that point, running that in the command line will output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate and previous output omitted 😉 @@ -153,7 +153,7 @@ This commit will generate this output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -182,7 +182,7 @@ This refresh will trigger the same SQL query that would be automatically trigger
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -210,7 +210,7 @@ So, printing it will show the new `age`:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 diff --git a/docs/tutorial/where.md b/docs/tutorial/where.md index 674404bff..1e33244b3 100644 --- a/docs/tutorial/where.md +++ b/docs/tutorial/where.md @@ -444,7 +444,7 @@ And in this case the results will be just one:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -624,7 +624,7 @@ We can then run it to see the output from the program:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 @@ -676,7 +676,7 @@ When we run it, this generates the output:
```console -$ python app.py +$ uv run python app.py // Some boilerplate output omitted 😉 diff --git a/docs/virtual-environments.md b/docs/virtual-environments.md index 0218120fb..b12bf7438 100644 --- a/docs/virtual-environments.md +++ b/docs/virtual-environments.md @@ -1,844 +1,35 @@ # Virtual Environments -When you work in Python projects you probably should use a **virtual environment** (or a similar mechanism) to isolate the packages you install for each project. +When you work with Python projects, you should use a **virtual environment** to isolate the packages installed for each project. -/// note +For SQLModel projects, I recommend using [uv](https://docs.astral.sh/uv/) to manage the project, its dependencies, and its virtual environment. -If you already know about virtual environments, how to create them and use them, you might want to skip this section. 🤓 +## Create a Project { #create-a-project } -/// - -/// tip - -A **virtual environment** is different than an **environment variable**. - -An **environment variable** is a variable in the system that can be used by programs. - -A **virtual environment** is a directory with some files in it. - -/// - -/// note - -This page will teach you how to use **virtual environments** and how they work. - -If you are ready to adopt a **tool that manages everything** for you (including installing Python), try [uv](https://github.com/astral-sh/uv). - -/// - -## Create a Project - -First, create a directory for your project. - -What I normally do is that I create a directory named `code` inside my home/user directory. - -And inside of that I create one directory per project. +Install `uv` using the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/), and then create a project:
```console -// Go to the home directory -$ cd -// Create a directory for all your code projects -$ mkdir code -// Enter into that code directory -$ cd code -// Create a directory for this project -$ mkdir awesome-project -// Enter into that project directory +$ uv init awesome-project --bare $ cd awesome-project +$ uv add sqlmodel ```
-## Create a Virtual Environment - -When you start working on a Python project **for the first time**, create a virtual environment **inside your project**. - -/// tip - -You only need to do this **once per project**, not every time you work. - -/// - -//// tab | `venv` - -To create a virtual environment, you can use the `venv` module that comes with Python. - -
- -```console -$ python -m venv .venv -``` - -
- -/// details | What that command means - -* `python`: use the program called `python` -* `-m`: call a module as a script, we'll tell it which module next -* `venv`: use the module called `venv` that normally comes installed with Python -* `.venv`: create the virtual environment in the new directory `.venv` - -/// - -//// - -//// tab | `uv` - -If you have [`uv`](https://github.com/astral-sh/uv) installed, you can use it to create a virtual environment. - -
- -```console -$ uv venv -``` - -
- -/// tip - -By default, `uv` will create a virtual environment in a directory called `.venv`. - -But you could customize it passing an additional argument with the directory name. - -/// - -//// - -That command creates a new virtual environment in a directory called `.venv`. - -/// details | `.venv` or other name - -You could create the virtual environment in a different directory, but there's a convention of calling it `.venv`. - -/// - -## Activate the Virtual Environment - -Activate the new virtual environment so that any Python command you run or package you install uses it. - -/// tip - -Do this **every time** you start a **new terminal session** to work on the project. - -/// - -//// tab | Linux, macOS - -
- -```console -$ source .venv/bin/activate -``` - -
- -//// - -//// tab | Windows PowerShell - -
- -```console -$ .venv\Scripts\Activate.ps1 -``` - -
- -//// - -//// tab | Windows Bash - -Or if you use Bash for Windows (e.g. [Git Bash](https://gitforwindows.org/)): - -
- -```console -$ source .venv/Scripts/activate -``` - -
- -//// - -/// tip - -Every time you install a **new package** in that environment, **activate** the environment again. - -This makes sure that if you use a **terminal (CLI) program** installed by that package, you use the one from your virtual environment and not any other that could be installed globally, probably with a different version than what you need. - -/// - -## Check the Virtual Environment is Active - -Check that the virtual environment is active (the previous command worked). - -/// tip - -This is **optional**, but it's a good way to **check** that everything is working as expected and you are using the virtual environment you intended. - -/// - -//// tab | Linux, macOS, Windows Bash - -
- -```console -$ which python - -/home/user/code/awesome-project/.venv/bin/python -``` - -
- -If it shows the `python` binary at `.venv/bin/python`, inside of your project (in this case `awesome-project`), then it worked. 🎉 - -//// - -//// tab | Windows PowerShell - -
- -```console -$ Get-Command python - -C:\Users\user\code\awesome-project\.venv\Scripts\python -``` - -
- -If it shows the `python` binary at `.venv\Scripts\python`, inside of your project (in this case `awesome-project`), then it worked. 🎉 - -//// - -## Upgrade `pip` - -/// tip - -If you use [`uv`](https://github.com/astral-sh/uv) you would use it to install things instead of `pip`, so you don't need to upgrade `pip`. 😎 - -/// - -If you are using `pip` to install packages (it comes by default with Python), you should **upgrade** it to the latest version. - -Many exotic errors while installing a package are solved by just upgrading `pip` first. - -/// tip - -You would normally do this **once**, right after you create the virtual environment. - -/// - -Make sure the virtual environment is active (with the command above) and then run: - -
- -```console -$ python -m pip install --upgrade pip - ----> 100% -``` - -
- -## Add `.gitignore` - -If you are using **Git** (you should), add a `.gitignore` file to exclude everything in your `.venv` from Git. - -/// tip - -If you used [`uv`](https://github.com/astral-sh/uv) to create the virtual environment, it already did this for you, you can skip this step. 😎 - -/// - -/// tip - -Do this **once**, right after you create the virtual environment. - -/// - -
- -```console -$ echo "*" > .venv/.gitignore -``` - -
- -/// details | What that command means - -* `echo "*"`: will "print" the text `*` in the terminal (the next part changes that a bit) -* `>`: anything printed to the terminal by the command to the left of `>` should not be printed but instead written to the file that goes to the right of `>` -* `.gitignore`: the name of the file where the text should be written - -And `*` for Git means "everything". So, it will ignore everything in the `.venv` directory. - -That command will create a file `.gitignore` with the content: - -```gitignore -* -``` - -/// - -## Install Packages - -After activating the environment, you can install packages in it. - -/// tip - -Do this **once** when installing or upgrading the packages your project needs. - -If you need to upgrade a version or add a new package you would **do this again**. - -/// - -### Install Packages Directly - -If you're in a hurry and don't want to use a file to declare your project's package requirements, you can install them directly. - -/// tip - -It's a (very) good idea to put the packages and versions your program needs in a file (for example `requirements.txt` or `pyproject.toml`). - -/// - -//// tab | `pip` - -
- -```console -$ pip install sqlmodel - ----> 100% -``` - -
- -//// - -//// tab | `uv` - -If you have [`uv`](https://github.com/astral-sh/uv): - -
- -```console -$ uv pip install sqlmodel ----> 100% -``` - -
- -//// - -### Install from `requirements.txt` - -If you have a `requirements.txt`, you can now use it to install its packages. - -//// tab | `pip` - -
- -```console -$ pip install -r requirements.txt ----> 100% -``` - -
- -//// - -//// tab | `uv` - -If you have [`uv`](https://github.com/astral-sh/uv): - -
- -```console -$ uv pip install -r requirements.txt ----> 100% -``` - -
- -//// - -/// details | `requirements.txt` - -A `requirements.txt` with some packages could look like: - -```requirements.txt -sqlmodel==0.13.0 -rich==13.7.1 -``` - -/// - -## Run Your Program - -After you activated the virtual environment, you can run your program, and it will use the Python inside of your virtual environment with the packages you installed there. - -
- -```console -$ python main.py - -Hello World -``` - -
- -## Configure Your Editor - -You would probably use an editor, make sure you configure it to use the same virtual environment you created (it will probably autodetect it) so that you can get autocompletion and inline errors. - -For example: - -* [VS Code](https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment) -* [PyCharm](https://www.jetbrains.com/help/pycharm/creating-virtual-environment.html) - -/// tip - -You normally have to do this only **once**, when you create the virtual environment. - -/// - -## Deactivate the Virtual Environment - -Once you are done working on your project you can **deactivate** the virtual environment. - -
- -```console -$ deactivate -``` - -
- -This way, when you run `python` it won't try to run it from that virtual environment with the packages installed there. - -## Ready to Work - -Now you're ready to start working on your project. - - - -/// tip - -Do you want to understand what's all that above? - -Continue reading. 👇🤓 - -/// - -## Why Virtual Environments - -To work with SQLModel you need to install [Python](https://www.python.org/). - -After that, you would need to **install** SQLModel and any other **packages** you want to use. - -To install packages you would normally use the `pip` command that comes with Python (or similar alternatives). - -Nevertheless, if you just use `pip` directly, the packages would be installed in your **global Python environment** (the global installation of Python). - -### The Problem - -So, what's the problem with installing packages in the global Python environment? - -At some point, you will probably end up writing many different programs that depend on **different packages**. And some of these projects you work on will depend on **different versions** of the same package. 😱 - -For example, you could create a project called `philosophers-stone`, this program depends on another package called **`harry`, using the version `1`**. So, you need to install `harry`. - -```mermaid -flowchart LR - stone(philosophers-stone) -->|requires| harry-1[harry v1] -``` - -Then, at some point later, you create another project called `prisoner-of-azkaban`, and this project also depends on `harry`, but this project needs **`harry` version `3`**. - -```mermaid -flowchart LR - azkaban(prisoner-of-azkaban) --> |requires| harry-3[harry v3] -``` - -But now the problem is, if you install the packages globally (in the global environment) instead of in a local **virtual environment**, you will have to choose which version of `harry` to install. - -If you want to run `philosophers-stone` you will need to first install `harry` version `1`, for example with: - -
- -```console -$ pip install "harry==1" -``` - -
- -And then you would end up with `harry` version `1` installed in your global Python environment. - -```mermaid -flowchart LR - subgraph global[global env] - harry-1[harry v1] - end - subgraph stone-project[philosophers-stone project] - stone(philosophers-stone) -->|requires| harry-1 - end -``` - -But then if you want to run `prisoner-of-azkaban`, you will need to uninstall `harry` version `1` and install `harry` version `3` (or just installing version `3` would automatically uninstall version `1`). - -
- -```console -$ pip install "harry==3" -``` - -
- -And then you would end up with `harry` version `3` installed in your global Python environment. - -And if you try to run `philosophers-stone` again, there's a chance it would **not work** because it needs `harry` version `1`. - -```mermaid -flowchart LR - subgraph global[global env] - harry-1[harry v1] - style harry-1 fill:#ccc,stroke-dasharray: 5 5 - harry-3[harry v3] - end - subgraph stone-project[philosophers-stone project] - stone(philosophers-stone) -.-x|⛔️| harry-1 - end - subgraph azkaban-project[prisoner-of-azkaban project] - azkaban(prisoner-of-azkaban) --> |requires| harry-3 - end -``` - -/// tip - -It's very common in Python packages to try the best to **avoid breaking changes** in **new versions**, but it's better to be safe, and install newer versions intentionally and when you can run the tests to check everything is working correctly. - -/// - -Now, imagine that with **many** other **packages** that all your **projects depend on**. That's very difficult to manage. And you would probably end up running some projects with some **incompatible versions** of the packages, and not knowing why something isn't working. - -Also, depending on your operating system (e.g. Linux, Windows, macOS), it could have come with Python already installed. And in that case it probably had some packages pre-installed with some specific versions **needed by your system**. If you install packages in the global Python environment, you could end up **breaking** some of the programs that came with your operating system. - -## Where are Packages Installed - -When you install Python, it creates some directories with some files in your computer. - -Some of these directories are the ones in charge of having all the packages you install. - -When you run: - -
- -```console -// Don't run this now, it's just an example 🤓 -$ pip install sqlmodel ----> 100% -``` - -
- -That will download a compressed file with the SQLModel code, normally from [PyPI](https://pypi.org/project/sqlmodel/). - -It will also **download** files for other packages that SQLModel depends on. - -Then it will **extract** all those files and put them in a directory in your computer. - -By default, it will put those files downloaded and extracted in the directory that comes with your Python installation, that's the **global environment**. - -## What are Virtual Environments - -The solution to the problems of having all the packages in the global environment is to use a **virtual environment for each project** you work on. - -A virtual environment is a **directory**, very similar to the global one, where you can install the packages for a project. - -This way, each project will have its own virtual environment (`.venv` directory) with its own packages. - -```mermaid -flowchart TB - subgraph stone-project[philosophers-stone project] - stone(philosophers-stone) --->|requires| harry-1 - subgraph venv1[.venv] - harry-1[harry v1] - end - end - subgraph azkaban-project[prisoner-of-azkaban project] - azkaban(prisoner-of-azkaban) --->|requires| harry-3 - subgraph venv2[.venv] - harry-3[harry v3] - end - end - stone-project ~~~ azkaban-project -``` - -## What Does Activating a Virtual Environment Mean - -When you activate a virtual environment, for example with: - -//// tab | Linux, macOS - -
- -```console -$ source .venv/bin/activate -``` - -
- -//// - -//// tab | Windows PowerShell - -
- -```console -$ .venv\Scripts\Activate.ps1 -``` - -
- -//// - -//// tab | Windows Bash - -Or if you use Bash for Windows (e.g. [Git Bash](https://gitforwindows.org/)): - -
- -```console -$ source .venv/Scripts/activate -``` - -
- -//// - -That command will create or modify some [environment variables](environment-variables.md) that will be available for the next commands. - -One of those variables is the `PATH` variable. - -/// tip - -You can learn more about the `PATH` environment variable in the [Environment Variables](environment-variables.md#path-environment-variable) section. - -/// - -Activating a virtual environment adds its path `.venv/bin` (on Linux and macOS) or `.venv\Scripts` (on Windows) to the `PATH` environment variable. - -Let's say that before activating the environment, the `PATH` variable looked like this: - -//// tab | Linux, macOS - -```plaintext -/usr/bin:/bin:/usr/sbin:/sbin -``` - -That means that the system would look for programs in: - -* `/usr/bin` -* `/bin` -* `/usr/sbin` -* `/sbin` - -//// - -//// tab | Windows - -```plaintext -C:\Windows\System32 -``` - -That means that the system would look for programs in: - -* `C:\Windows\System32` - -//// - -After activating the virtual environment, the `PATH` variable would look something like this: - -//// tab | Linux, macOS - -```plaintext -/home/user/code/awesome-project/.venv/bin:/usr/bin:/bin:/usr/sbin:/sbin -``` - -That means that the system will now start looking first for programs in: - -```plaintext -/home/user/code/awesome-project/.venv/bin -``` - -before looking in the other directories. - -So, when you type `python` in the terminal, the system will find the Python program in - -```plaintext -/home/user/code/awesome-project/.venv/bin/python -``` - -and use that one. - -//// - -//// tab | Windows - -```plaintext -C:\Users\user\code\awesome-project\.venv\Scripts;C:\Windows\System32 -``` - -That means that the system will now start looking first look for programs in: - -```plaintext -C:\Users\user\code\awesome-project\.venv\Scripts -``` - -before looking in the other directories. - -So, when you type `python` in the terminal, the system will find the Python program in - -```plaintext -C:\Users\user\code\awesome-project\.venv\Scripts\python -``` - -and use that one. - -//// - -An important detail is that it will put the virtual environment path at the **beginning** of the `PATH` variable. The system will find it **before** finding any other Python available. This way, when you run `python`, it will use the Python **from the virtual environment** instead of any other `python` (for example, a `python` from a global environment). - -Activating a virtual environment also changes a couple of other things, but this is one of the most important things it does. - -## Checking a Virtual Environment - -When you check if a virtual environment is active, for example with: - -//// tab | Linux, macOS, Windows Bash - -
- -```console -$ which python - -/home/user/code/awesome-project/.venv/bin/python -``` - -
- -//// - -//// tab | Windows PowerShell - -
- -```console -$ Get-Command python - -C:\Users\user\code\awesome-project\.venv\Scripts\python -``` - -
- -//// - -That means that the `python` program that will be used is the one **in the virtual environment**. - -you use `which` in Linux and macOS and `Get-Command` in Windows PowerShell. - -The way that command works is that it will go and check in the `PATH` environment variable, going through **each path in order**, looking for the program called `python`. Once it finds it, it will **show you the path** to that program. - -The most important part is that when you call `python`, that is the exact "`python`" that will be executed. - -So, you can confirm if you are in the correct virtual environment. - -/// tip - -It's easy to activate one virtual environment, get one Python, and then **go to another project**. - -And the second project **wouldn't work** because you are using the **incorrect Python**, from a virtual environment for another project. - -It's useful being able to check what `python` is being used. 🤓 - -/// - -## Why Deactivate a Virtual Environment - -For example, you could be working on a project `philosophers-stone`, **activate that virtual environment**, install packages and work with that environment. - -And then you want to work on **another project** `prisoner-of-azkaban`. - -You go to that project: - -
- -```console -$ cd ~/code/prisoner-of-azkaban -``` - -
- -If you don't deactivate the virtual environment for `philosophers-stone`, when you run `python` in the terminal, it will try to use the Python from `philosophers-stone`. - -
- -```console -$ cd ~/code/prisoner-of-azkaban - -$ python main.py - -// Error importing sirius, it's not installed 😱 -Traceback (most recent call last): - File "main.py", line 1, in - import sirius -``` - -
+`uv` creates a virtual environment for the project automatically. You don't need to create or activate one yourself. -But if you deactivate the virtual environment and activate the new one for `prisoner-of-askaban` then when you run `python` it will use the Python from the virtual environment in `prisoner-of-azkaban`. +Run commands inside the project environment with `uv run`, for example:
```console -$ cd ~/code/prisoner-of-azkaban - -// You don't need to be in the old directory to deactivate, you can do it wherever you are, even after going to the other project 😎 -$ deactivate - -// Activate the virtual environment in prisoner-of-azkaban/.venv 🚀 -$ source .venv/bin/activate - -// Now when you run python, it will find the package sirius installed in this virtual environment ✨ -$ python main.py - -I solemnly swear 🐺 +$ uv run python app.py ```
-## Alternatives - -This is a simple guide to get you started and teach you how everything works **underneath**. - -There are many **alternatives** to managing virtual environments, package dependencies (requirements), projects. - -Once you are ready and want to use a tool to **manage the entire project**, packages dependencies, virtual environments, etc. I would suggest you try [uv](https://github.com/astral-sh/uv). - -`uv` can do a lot of things, it can: - -* **Install Python** for you, including different versions -* Manage the **virtual environment** for your projects -* Install **packages** -* Manage package **dependencies and versions** for your project -* Make sure you have an **exact** set of packages and versions to install, including their dependencies, so that you can be sure that you can run your project in production exactly the same as in your computer while developing, this is called **locking** -* And many other things - -## Conclusion - -If you read and understood all this, now **you know much more** about virtual environments than many developers out there. 🤓 +## Learn More { #learn-more } -Knowing these details will most probably be useful in a future time when you are debugging something that seems complex, but you will know **how it all works underneath**. 😎 +Read the [Virtual Environments guide](https://tiangolo.com/guides/virtual-environments/) to learn how virtual environments work underneath, including activation and the alternative `python -m venv` and `pip` workflow. diff --git a/mkdocs.yml b/mkdocs.yml index 3ad1b05c0..56dd943e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,8 +63,6 @@ nav: - learn/index.md - databases.md - db-to-code.md - - environment-variables.md - - virtual-environments.md - install.md - "": - tutorial/index.md -- 2.47.3