Skip to content

Commit

Permalink
馃摑 Add misc dependency installs to tutorial docs (tiangolo#2126)
Browse files Browse the repository at this point in the history
Co-authored-by: Sebasti谩n Ram铆rez <tiangolo@gmail.com>
  • Loading branch information
2 people authored and JeanArhancet committed Aug 20, 2022
1 parent c6ddd6c commit ed831cd
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/en/docs/advanced/websockets.md
Expand Up @@ -2,6 +2,20 @@

You can use <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API" class="external-link" target="_blank">WebSockets</a> with **FastAPI**.

## Install `WebSockets`

First you need to install `WebSockets`:

<div class="termy">

```console
$ pip install websockets

---> 100%
```

</div>

## WebSockets client

### In production
Expand Down
6 changes: 6 additions & 0 deletions docs/en/docs/tutorial/response-model.md
Expand Up @@ -61,6 +61,12 @@ Here we are declaring a `UserIn` model, it will contain a plaintext password:
{!> ../../../docs_src/response_model/tutorial002_py310.py!}
```

!!! info
To use `EmailStr`, first install <a href="https://github.com/JoshData/python-email-validator" class="external-link" target="_blank">`email_validator`</a>.

E.g. `pip install email-validator`
or `pip install pydantic[email]`.

And we are using this model to declare our input and the same model to declare our output:

=== "Python 3.6 and above"
Expand Down
14 changes: 14 additions & 0 deletions docs/en/docs/tutorial/sql-databases.md
Expand Up @@ -80,6 +80,20 @@ The file `__init__.py` is just an empty file, but it tells Python that `sql_app`

Now let's see what each file/module does.

## Install `SQLAlchemy`

First you need to install `SQLAlchemy`:

<div class="termy">

```console
$ pip install sqlalchemy

---> 100%
```

</div>

## Create the SQLAlchemy parts

Let's refer to the file `sql_app/database.py`.
Expand Down
5 changes: 5 additions & 0 deletions docs/en/docs/tutorial/testing.md
Expand Up @@ -8,6 +8,11 @@ With it, you can use <a href="https://docs.pytest.org/" class="external-link" ta

## Using `TestClient`

!!! info
To use `TestClient`, first install <a href="https://github.com/psf/requests" class="external-link" target="_blank">`requests`</a>.

E.g. `pip install requests`.

Import `TestClient`.

Create a `TestClient` by passing your **FastAPI** application to it.
Expand Down

0 comments on commit ed831cd

Please sign in to comment.