From c54fb7e20804698bf9ba9422fd92e53fa85114ad Mon Sep 17 00:00:00 2001 From: tomwei7 Date: Thu, 7 Oct 2021 23:57:38 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20docs=20with=20pip=20ins?= =?UTF-8?q?tall=20calls=20when=20using=20extras=20with=20brackets,=20use?= =?UTF-8?q?=20quotes=20for=20compatibility=20with=20Zsh=20(#3131)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sebastián Ramírez --- README.md | 4 ++-- docs/en/docs/deployment/manually.md | 2 +- docs/en/docs/deployment/server-workers.md | 2 +- docs/en/docs/index.md | 4 ++-- docs/en/docs/tutorial/index.md | 4 ++-- docs/en/docs/tutorial/security/oauth2-jwt.md | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index b1c815dc7..830031581 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ You will also need an ASGI server, for production such as ```console -$ pip install uvicorn[standard] +$ pip install "uvicorn[standard]" ---> 100% ``` @@ -456,7 +456,7 @@ Used by FastAPI / Starlette: * uvicorn - for the server that loads and serves your application. * orjson - Required if you want to use `ORJSONResponse`. -You can install all of these with `pip install fastapi[all]`. +You can install all of these with `pip install "fastapi[all]"`. ## License diff --git a/docs/en/docs/deployment/manually.md b/docs/en/docs/deployment/manually.md index 6a3619b65..7fd1f4d4f 100644 --- a/docs/en/docs/deployment/manually.md +++ b/docs/en/docs/deployment/manually.md @@ -29,7 +29,7 @@ You can install an ASGI compatible server with:
```console - $ pip install uvicorn[standard] + $ pip install "uvicorn[standard]" ---> 100% ``` diff --git a/docs/en/docs/deployment/server-workers.md b/docs/en/docs/deployment/server-workers.md index 2892d5797..84a2b0f33 100644 --- a/docs/en/docs/deployment/server-workers.md +++ b/docs/en/docs/deployment/server-workers.md @@ -39,7 +39,7 @@ And then the Gunicorn-compatible **Uvicorn worker** class would be in charge of
```console -$ pip install uvicorn[standard] gunicorn +$ pip install "uvicorn[standard]" gunicorn ---> 100% ``` diff --git a/docs/en/docs/index.md b/docs/en/docs/index.md index aa2c16a2e..7de1e50df 100644 --- a/docs/en/docs/index.md +++ b/docs/en/docs/index.md @@ -134,7 +134,7 @@ You will also need an ASGI server, for production such as ```console -$ pip install uvicorn[standard] +$ pip install "uvicorn[standard]" ---> 100% ``` @@ -457,7 +457,7 @@ Used by FastAPI / Starlette: * uvicorn - for the server that loads and serves your application. * orjson - Required if you want to use `ORJSONResponse`. -You can install all of these with `pip install fastapi[all]`. +You can install all of these with `pip install "fastapi[all]"`. ## License diff --git a/docs/en/docs/tutorial/index.md b/docs/en/docs/tutorial/index.md index bd02cd539..8b4a9df9b 100644 --- a/docs/en/docs/tutorial/index.md +++ b/docs/en/docs/tutorial/index.md @@ -43,7 +43,7 @@ For the tutorial, you might want to install it with all the optional dependencie
```console -$ pip install fastapi[all] +$ pip install "fastapi[all]" ---> 100% ``` @@ -64,7 +64,7 @@ $ pip install fastapi[all] Also install `uvicorn` to work as the server: ``` - pip install uvicorn[standard] + pip install "uvicorn[standard]" ``` And the same for each of the optional dependencies that you want to use. diff --git a/docs/en/docs/tutorial/security/oauth2-jwt.md b/docs/en/docs/tutorial/security/oauth2-jwt.md index fda722cd1..f88cf23c0 100644 --- a/docs/en/docs/tutorial/security/oauth2-jwt.md +++ b/docs/en/docs/tutorial/security/oauth2-jwt.md @@ -33,7 +33,7 @@ We need to install `python-jose` to generate and verify the JWT tokens in Python
```console -$ pip install python-jose[cryptography] +$ pip install "python-jose[cryptography]" ---> 100% ``` @@ -76,7 +76,7 @@ So, install PassLib with Bcrypt:
```console -$ pip install passlib[bcrypt] +$ pip install "passlib[bcrypt]" ---> 100% ```