Thanks to visit codestin.com
Credit goes to github.com

Skip to content

📝 Add misc dependency installs to tutorial docs #2126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tiangolo merged 5 commits into from
Aug 18, 2022
Merged

📝 Add misc dependency installs to tutorial docs #2126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8942220
📝 Add notes about installing `email-validator` for `EmailStr`
TeoZosa Oct 3, 2020
b8cc45b
📝 Add notes about installing `requests` for `TestClient`
TeoZosa Oct 3, 2020
8247ff6
📝 Add notes about installing `sqlalchemy`
TeoZosa Oct 3, 2020
b589bde
📝 Add notes about installing `websockets`
TeoZosa Oct 5, 2020
307c183
Merge branch 'master' into add-misc-dependency-installs-to-tutorial-docs
tiangolo Aug 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/en/docs/advanced/websockets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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