]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
📝 Update docs with pip install calls when using extras with brackets, use quotes...
authortomwei7 <tomwei7g@gmail.com>
Thu, 7 Oct 2021 15:57:38 +0000 (23:57 +0800)
committerGitHub <noreply@github.com>
Thu, 7 Oct 2021 15:57:38 +0000 (17:57 +0200)
Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
README.md
docs/en/docs/deployment/manually.md
docs/en/docs/deployment/server-workers.md
docs/en/docs/index.md
docs/en/docs/tutorial/index.md
docs/en/docs/tutorial/security/oauth2-jwt.md

index b1c815dc71d9cb01683a72ce9d383859e5864d97..8300315817254f430913aab272deea22feb20d5d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -133,7 +133,7 @@ You will also need an ASGI server, for production such as <a href="https://www.u
 <div class="termy">
 
 ```console
-$ pip install uvicorn[standard]
+$ pip install "uvicorn[standard]"
 
 ---> 100%
 ```
@@ -456,7 +456,7 @@ Used by FastAPI / Starlette:
 * <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
 * <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - 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
 
index 6a3619b65a19619e15afe4e7dcbbffcdafcb77a9..7fd1f4d4f2f962614fc594ac1b99d1ee54d84335 100644 (file)
@@ -29,7 +29,7 @@ You can install an ASGI compatible server with:
     <div class="termy">
 
     ```console
-    $ pip install uvicorn[standard]
+    $ pip install "uvicorn[standard]"
 
     ---> 100%
     ```
index 2892d5797e5f98549ce473c4a60e9587494cfd26..84a2b0f33f7a2c2bd401eaf6d2b043f525319fb1 100644 (file)
@@ -39,7 +39,7 @@ And then the Gunicorn-compatible **Uvicorn worker** class would be in charge of
 <div class="termy">
 
 ```console
-$ pip install uvicorn[standard] gunicorn
+$ pip install "uvicorn[standard]" gunicorn
 
 ---> 100%
 ```
index aa2c16a2e6d619f689d35b92db516ab0d85c6721..7de1e50df5627f3e31b87193048548d36bb008ca 100644 (file)
@@ -134,7 +134,7 @@ You will also need an ASGI server, for production such as <a href="https://www.u
 <div class="termy">
 
 ```console
-$ pip install uvicorn[standard]
+$ pip install "uvicorn[standard]"
 
 ---> 100%
 ```
@@ -457,7 +457,7 @@ Used by FastAPI / Starlette:
 * <a href="https://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
 * <a href="https://github.com/ijl/orjson" target="_blank"><code>orjson</code></a> - 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
 
index bd02cd53935d37f9f21ba012feb1b2ed57605f7a..8b4a9df9be8cc9597016c0eefae30e73fbea3df7 100644 (file)
@@ -43,7 +43,7 @@ For the tutorial, you might want to install it with all the optional dependencie
 <div class="termy">
 
 ```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.
index fda722cd10db5b64d7db96ebfbb68695edd38725..f88cf23c0e5add57d04dd4591cabecdf3e2c1f0c 100644 (file)
@@ -33,7 +33,7 @@ We need to install `python-jose` to generate and verify the JWT tokens in Python
 <div class="termy">
 
 ```console
-$ pip install python-jose[cryptography]
+$ pip install "python-jose[cryptography]"
 
 ---> 100%
 ```
@@ -76,7 +76,7 @@ So, install PassLib with Bcrypt:
 <div class="termy">
 
 ```console
-$ pip install passlib[bcrypt]
+$ pip install "passlib[bcrypt]"
 
 ---> 100%
 ```