fastapi 0.110.3.dev1__tar.gz → 0.111.0__tar.gz

{fastapi-0.110.3.dev1 → fastapi-0.111.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi
-Version: 0.110.3.dev1
+Version: 0.111.0
 Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 Classifier: Intended Audience :: Information Technology
@@ -37,13 +37,14 @@ Requires-Python: >=3.8
 Requires-Dist: starlette<0.38.0,>=0.37.2
 Requires-Dist: pydantic!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.7.4
 Requires-Dist: typing-extensions>=4.8.0
-Requires-Dist: httpx>=0.23.0; extra == "standard"
-Requires-Dist: jinja2>=2.11.2; extra == "standard"
-Requires-Dist: python-multipart>=0.0.7; extra == "standard"
-Requires-Dist: email_validator>=2.0.0; extra == "standard"
-Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
-Requires-Dist: pydantic-settings>=2.0.0; extra == "standard"
-Requires-Dist: pydantic-extra-types>=2.0.0; extra == "standard"
+Requires-Dist: fastapi-cli>=0.0.2
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: jinja2>=2.11.2
+Requires-Dist: python-multipart>=0.0.7
+Requires-Dist: ujson!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0,>=4.0.1
+Requires-Dist: orjson>=3.2.1
+Requires-Dist: email_validator>=2.0.0
+Requires-Dist: uvicorn[standard]>=0.12.0
 Requires-Dist: httpx>=0.23.0; extra == "all"
 Requires-Dist: jinja2>=2.11.2; extra == "all"
 Requires-Dist: python-multipart>=0.0.7; extra == "all"
@@ -55,7 +56,6 @@ Requires-Dist: email_validator>=2.0.0; extra == "all"
 Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"
 Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
 Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"
-Provides-Extra: standard
 Provides-Extra: all
 Description-Content-Type: text/markdown
 
@@ -200,18 +200,6 @@ $ pip install fastapi
 
 </div>
 
-You will also need an ASGI server, for production such as <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> or <a href="https://github.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>.
-
-<div class="termy">
-
-```console
-$ pip install "uvicorn[standard]"
-
----> 100%
-```
-
-</div>
-
 ## Example
 
 ### Create it
@@ -272,11 +260,24 @@ Run the server with:
 <div class="termy">
 
 ```console
-$ uvicorn main:app --reload
-
+$ fastapi dev main.py
+
+ ╭────────── FastAPI CLI - Development mode ───────────╮
+ │                                                     │
+ │  Serving at: http://127.0.0.1:8000                  │
+ │                                                     │
+ │  API docs: http://127.0.0.1:8000/docs               │
+ │                                                     │
+ │  Running in development mode, for production use:   │
+ │                                                     │
+ │  fastapi run                                        │
+ │                                                     │
+ ╰─────────────────────────────────────────────────────╯
+
+INFO:     Will watch for changes in these directories: ['/home/user/code/awesomeapp']
 INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
-INFO:     Started reloader process [28720]
-INFO:     Started server process [28722]
+INFO:     Started reloader process [2248755] using WatchFiles
+INFO:     Started server process [2248757]
 INFO:     Waiting for application startup.
 INFO:     Application startup complete.
 ```
@@ -284,13 +285,13 @@ INFO:     Application startup complete.
 </div>
 
 <details markdown="1">
-<summary>About the command <code>uvicorn main:app --reload</code>...</summary>
+<summary>About the command <code>fastapi dev main.py</code>...</summary>
 
-The command `uvicorn main:app` refers to:
+The command `fastapi dev` reads your `main.py` file, detects the **FastAPI** app in it, and starts a server using <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>.
 
-* `main`: the file `main.py` (the Python "module").
-* `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
-* `--reload`: make the server restart after code changes. Only do this for development.
+By default, `fastapi dev` will start with auto-reload enabled for local development.
+
+You can read more about it in the <a href="https://fastapi.tiangolo.com/fastapi-cli/" target="_blank">FastAPI CLI docs</a>.
 
 </details>
 
@@ -363,7 +364,7 @@ def update_item(item_id: int, item: Item):
     return {"item_name": item.name, "item_id": item_id}
 ```
 
-The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
+The `fastapi dev` server should reload automatically.
 
 ### Interactive API docs upgrade
 
@@ -507,7 +508,7 @@ Independent TechEmpower benchmarks show **FastAPI** applications running under U
 
 To understand more about it, see the section <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>.
 
-## Optional Dependencies
+## Dependencies
 
 Used by Pydantic:
 
@@ -520,16 +521,33 @@ Used by Starlette:
 * <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - Required if you want to use the `TestClient`.
 * <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
 * <a href="https://github.com/Kludex/python-multipart" target="_blank"><code>python-multipart</code></a> - Required if you want to support form <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with `request.form()`.
-* <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support.
-* <a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a> - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
 
 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`.
 * <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
+* `fastapi-cli` - to provide the `fastapi` command.
+
+When you install `fastapi` it comes these standard dependencies.
+
+## `fastapi-slim`
+
+If you don't want the extra standard optional dependencies, install `fastapi-slim` instead.
+
+When you install with:
+
+```bash
+pip install fastapi
+```
+
+...it includes the same code and dependencies as:
+
+```bash
+pip install "fastapi-slim[standard]"
+```
 
-You can install all of these with `pip install "fastapi[all]"`.
+The standard extra dependencies are the ones mentioned above.
 
 ## License
 

{fastapi-0.110.3.dev1 → fastapi-0.111.0}/README.md

@@ -139,18 +139,6 @@ $ pip install fastapi
 
 </div>
 
-You will also need an ASGI server, for production such as <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a> or <a href="https://github.com/pgjones/hypercorn" class="external-link" target="_blank">Hypercorn</a>.
-
-<div class="termy">
-
-```console
-$ pip install "uvicorn[standard]"
-
----> 100%
-```
-
-</div>
-
 ## Example
 
 ### Create it
@@ -211,11 +199,24 @@ Run the server with:
 <div class="termy">
 
 ```console
-$ uvicorn main:app --reload
-
+$ fastapi dev main.py
+
+ ╭────────── FastAPI CLI - Development mode ───────────╮
+ │                                                     │
+ │  Serving at: http://127.0.0.1:8000                  │
+ │                                                     │
+ │  API docs: http://127.0.0.1:8000/docs               │
+ │                                                     │
+ │  Running in development mode, for production use:   │
+ │                                                     │
+ │  fastapi run                                        │
+ │                                                     │
+ ╰─────────────────────────────────────────────────────╯
+
+INFO:     Will watch for changes in these directories: ['/home/user/code/awesomeapp']
 INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
-INFO:     Started reloader process [28720]
-INFO:     Started server process [28722]
+INFO:     Started reloader process [2248755] using WatchFiles
+INFO:     Started server process [2248757]
 INFO:     Waiting for application startup.
 INFO:     Application startup complete.
 ```
@@ -223,13 +224,13 @@ INFO:     Application startup complete.
 </div>
 
 <details markdown="1">
-<summary>About the command <code>uvicorn main:app --reload</code>...</summary>
+<summary>About the command <code>fastapi dev main.py</code>...</summary>
 
-The command `uvicorn main:app` refers to:
+The command `fastapi dev` reads your `main.py` file, detects the **FastAPI** app in it, and starts a server using <a href="https://www.uvicorn.org" class="external-link" target="_blank">Uvicorn</a>.
 
-* `main`: the file `main.py` (the Python "module").
-* `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
-* `--reload`: make the server restart after code changes. Only do this for development.
+By default, `fastapi dev` will start with auto-reload enabled for local development.
+
+You can read more about it in the <a href="https://fastapi.tiangolo.com/fastapi-cli/" target="_blank">FastAPI CLI docs</a>.
 
 </details>
 
@@ -302,7 +303,7 @@ def update_item(item_id: int, item: Item):
     return {"item_name": item.name, "item_id": item_id}
 ```
 
-The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
+The `fastapi dev` server should reload automatically.
 
 ### Interactive API docs upgrade
 
@@ -446,7 +447,7 @@ Independent TechEmpower benchmarks show **FastAPI** applications running under U
 
 To understand more about it, see the section <a href="https://fastapi.tiangolo.com/benchmarks/" class="internal-link" target="_blank">Benchmarks</a>.
 
-## Optional Dependencies
+## Dependencies
 
 Used by Pydantic:
 
@@ -459,16 +460,33 @@ Used by Starlette:
 * <a href="https://www.python-httpx.org" target="_blank"><code>httpx</code></a> - Required if you want to use the `TestClient`.
 * <a href="https://jinja.palletsprojects.com" target="_blank"><code>jinja2</code></a> - Required if you want to use the default template configuration.
 * <a href="https://github.com/Kludex/python-multipart" target="_blank"><code>python-multipart</code></a> - Required if you want to support form <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>, with `request.form()`.
-* <a href="https://pythonhosted.org/itsdangerous/" target="_blank"><code>itsdangerous</code></a> - Required for `SessionMiddleware` support.
-* <a href="https://pyyaml.org/wiki/PyYAMLDocumentation" target="_blank"><code>pyyaml</code></a> - Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
 
 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`.
 * <a href="https://github.com/esnme/ultrajson" target="_blank"><code>ujson</code></a> - Required if you want to use `UJSONResponse`.
+* `fastapi-cli` - to provide the `fastapi` command.
+
+When you install `fastapi` it comes these standard dependencies.
+
+## `fastapi-slim`
+
+If you don't want the extra standard optional dependencies, install `fastapi-slim` instead.
+
+When you install with:
+
+```bash
+pip install fastapi
+```
+
+...it includes the same code and dependencies as:
+
+```bash
+pip install "fastapi-slim[standard]"
+```
 
-You can install all of these with `pip install "fastapi[all]"`.
+The standard extra dependencies are the ones mentioned above.
 
 ## License
 

{fastapi-0.110.3.dev1 → fastapi-0.111.0}/fastapi/__init__.py

@@ -1,6 +1,6 @@
 """FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
 
-__version__ = "0.110.3.dev1"
+__version__ = "0.111.0"
 
 from starlette import status as status
 

fastapi-0.111.0/pdm_build.py

@@ -0,0 +1,39 @@
+import os
+from typing import Any, Dict, List
+
+from pdm.backend.hooks import Context
+
+TIANGOLO_BUILD_PACKAGE = os.getenv("TIANGOLO_BUILD_PACKAGE", "fastapi")
+
+
+def pdm_build_initialize(context: Context) -> None:
+    metadata = context.config.metadata
+    # Get custom config for the current package, from the env var
+    config: Dict[str, Any] = context.config.data["tool"]["tiangolo"][
+        "_internal-slim-build"
+    ]["packages"][TIANGOLO_BUILD_PACKAGE]
+    project_config: Dict[str, Any] = config["project"]
+    # Get main optional dependencies, extras
+    optional_dependencies: Dict[str, List[str]] = metadata.get(
+        "optional-dependencies", {}
+    )
+    # Get custom optional dependencies name to always include in this (non-slim) package
+    include_optional_dependencies: List[str] = config.get(
+        "include-optional-dependencies", []
+    )
+    # Override main [project] configs with custom configs for this package
+    for key, value in project_config.items():
+        metadata[key] = value
+    # Get custom build config for the current package
+    build_config: Dict[str, Any] = (
+        config.get("tool", {}).get("pdm", {}).get("build", {})
+    )
+    # Override PDM build config with custom build config for this package
+    for key, value in build_config.items():
+        context.config.build_config[key] = value
+    # Get main dependencies
+    dependencies: List[str] = metadata.get("dependencies", [])
+    # Add optional dependencies to the default dependencies for this (non-slim) package
+    for include_optional in include_optional_dependencies:
+        optional_dependencies_group = optional_dependencies.get(include_optional, [])
+        dependencies.extend(optional_dependencies_group)

{fastapi-0.110.3.dev1 → fastapi-0.111.0}/pyproject.toml

@@ -46,8 +46,16 @@ dependencies = [
     "starlette>=0.37.2,<0.38.0",
     "pydantic>=1.7.4,!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0",
     "typing-extensions>=4.8.0",
+    "fastapi-cli >=0.0.2",
+    "httpx >=0.23.0",
+    "jinja2 >=2.11.2",
+    "python-multipart >=0.0.7",
+    "ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0",
+    "orjson >=3.2.1",
+    "email_validator >=2.0.0",
+    "uvicorn[standard] >=0.12.0",
 ]
-version = "0.110.3.dev1"
+version = "0.111.0"
 
 [project.urls]
 Homepage = "https://github.com/tiangolo/fastapi"
@@ -55,15 +63,6 @@ Documentation = "https://fastapi.tiangolo.com/"
 Repository = "https://github.com/tiangolo/fastapi"
 
 [project.optional-dependencies]
-standard = [
-    "httpx >=0.23.0",
-    "jinja2 >=2.11.2",
-    "python-multipart >=0.0.7",
-    "email_validator >=2.0.0",
-    "uvicorn[standard] >=0.12.0",
-    "pydantic-settings >=2.0.0",
-    "pydantic-extra-types >=2.0.0",
-]
 all = [
     "httpx >=0.23.0",
     "jinja2 >=2.11.2",
@@ -91,6 +90,30 @@ source-includes = [
     "docs_src/",
     "requirements*.txt",
     "scripts/",
+    "docs/en/docs/img/favicon.png",
+]
+
+[tool.tiangolo._internal-slim-build.packages.fastapi-slim.project]
+name = "fastapi-slim"
+
+[tool.tiangolo._internal-slim-build.packages.fastapi]
+include-optional-dependencies = [
+    "standard",
+]
+
+[tool.tiangolo._internal-slim-build.packages.fastapi.project.optional-dependencies]
+all = [
+    "httpx >=0.23.0",
+    "jinja2 >=2.11.2",
+    "python-multipart >=0.0.7",
+    "itsdangerous >=1.1.0",
+    "pyyaml >=5.3.1",
+    "ujson >=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0",
+    "orjson >=3.2.1",
+    "email_validator >=2.0.0",
+    "uvicorn[standard] >=0.12.0",
+    "pydantic-settings >=2.0.0",
+    "pydantic-extra-types >=2.0.0",
 ]
 
 [tool.mypy]

{fastapi-0.110.3.dev1 → fastapi-0.111.0}/scripts/format.sh

@@ -1,5 +1,5 @@
 #!/bin/sh -e
 set -x
 
-ruff fastapi tests docs_src scripts --fix
+ruff check fastapi tests docs_src scripts --fix
 ruff format fastapi tests docs_src scripts

{fastapi-0.110.3.dev1 → fastapi-0.111.0}/scripts/lint.sh

@@ -4,5 +4,5 @@ set -e
 set -x
 
 mypy fastapi
-ruff fastapi tests docs_src scripts
+ruff check fastapi tests docs_src scripts
 ruff format fastapi tests --check

fastapi-0.110.3.dev1/scripts/build-docs.sh

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-set -x
-
-# Check README.md is up to date
-python ./scripts/docs.py verify-docs
-python ./scripts/docs.py build-all

fastapi-0.110.3.dev1/scripts/clean.sh

@@ -1,8 +0,0 @@
-#!/bin/sh -e
-
-if [ -d 'dist' ] ; then
-    rm -r dist
-fi
-if [ -d 'site' ] ; then
-    rm -r site
-fi

fastapi-0.110.3.dev1/scripts/docs-live.sh

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-mkdocs serve --dev-addr 0.0.0.0:8008

fastapi-0.110.3.dev1/scripts/netlify-docs.sh

@@ -1,14 +0,0 @@
-#!/usr/bin/env bash
-set -x
-set -e
-# Install pip
-cd /tmp
-curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
-python3.6 get-pip.py --user
-cd -
-# Install Flit to be able to install all
-python3.6 -m pip install --user flit
-# Install with Flit
-python3.6 -m flit install --user --extras doc
-# Finally, run mkdocs
-python3.6 -m mkdocs build

fastapi-0.110.3.dev1/scripts/publish.sh

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-flit publish