diff --git a/docs/deployment.md b/docs/deployment.md index 3de15e6d1..268ab0ba6 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -31,39 +31,31 @@ Usage: uvicorn [OPTIONS] APP Options: --host TEXT Bind socket to this host. [default: 127.0.0.1] - --port INTEGER Bind socket to this port. [default: 8000] --uds TEXT Bind to a UNIX domain socket. --fd INTEGER Bind to socket from this file descriptor. --reload Enable auto-reload. --reload-dir TEXT Set reload directories explicitly, instead of using the current working directory. - --reload-delay FLOAT Delay between previous and next check if application needs to be. Defaults to 0.25s. [default: 0.25] - --workers INTEGER Number of worker processes. Defaults to the $WEB_CONCURRENCY environment variable if available, or 1. Not valid with --reload. - --loop [auto|asyncio|uvloop] Event loop implementation. [default: auto] --http [auto|h11|httptools] HTTP protocol implementation. [default: auto] - --ws [auto|none|websockets|wsproto] WebSocket protocol implementation. [default: auto] - --lifespan [auto|on|off] Lifespan implementation. [default: auto] --interface [auto|asgi3|asgi2|wsgi] Select ASGI3, ASGI2, or WSGI as the application interface. [default: auto] - --env-file PATH Environment configuration file. --log-config PATH Logging configuration file. Supported formats: .ini, .json, .yaml. - --log-level [critical|error|warning|info|debug|trace] Log level. [default: info] --access-log / --no-access-log Enable/Disable access log. @@ -72,53 +64,40 @@ Options: Enable/Disable X-Forwarded-Proto, X-Forwarded-For, X-Forwarded-Port to populate remote address info. - --forwarded-allow-ips TEXT Comma seperated list of IPs to trust with proxy headers. Defaults to the $FORWARDED_ALLOW_IPS environment variable if available, or '127.0.0.1'. - --root-path TEXT Set the ASGI 'root_path' for applications submounted below a given URL path. - --limit-concurrency INTEGER Maximum number of concurrent connections or tasks to allow, before issuing HTTP 503 responses. - --backlog INTEGER Maximum number of connections to hold in backlog - --limit-max-requests INTEGER Maximum number of requests to service before terminating the process. - --timeout-keep-alive INTEGER Close Keep-Alive connections if no new data is received within this timeout. [default: 5] - --ssl-keyfile TEXT SSL key file --ssl-certfile TEXT SSL certificate file --ssl-keyfile-password TEXT SSL keyfile password --ssl-version INTEGER SSL version to use (see stdlib ssl module's) [default: 2] - --ssl-cert-reqs INTEGER Whether client certificate is required (see stdlib ssl module's) [default: 0] - --ssl-ca-certs TEXT CA certificates file --ssl-ciphers TEXT Ciphers to use (see stdlib ssl module's) [default: TLSv1] - --header TEXT Specify custom default HTTP response headers as a Name:Value pair - --version Display the uvicorn version and exit. --app-dir TEXT Look for APP in the specified directory, by adding this to the PYTHONPATH. Defaults to the current working directory. [default: .] - --factory Treat APP as an application factory, i.e. a () -> callable. [default: False] - --help Show this message and exit. ``` diff --git a/docs/index.md b/docs/index.md index ae587f2ee..fcba8bf2d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -101,39 +101,31 @@ Usage: uvicorn [OPTIONS] APP Options: --host TEXT Bind socket to this host. [default: 127.0.0.1] - --port INTEGER Bind socket to this port. [default: 8000] --uds TEXT Bind to a UNIX domain socket. --fd INTEGER Bind to socket from this file descriptor. --reload Enable auto-reload. --reload-dir TEXT Set reload directories explicitly, instead of using the current working directory. - --reload-delay FLOAT Delay between previous and next check if application needs to be. Defaults to 0.25s. [default: 0.25] - --workers INTEGER Number of worker processes. Defaults to the $WEB_CONCURRENCY environment variable if available, or 1. Not valid with --reload. - --loop [auto|asyncio|uvloop] Event loop implementation. [default: auto] --http [auto|h11|httptools] HTTP protocol implementation. [default: auto] - --ws [auto|none|websockets|wsproto] WebSocket protocol implementation. [default: auto] - --lifespan [auto|on|off] Lifespan implementation. [default: auto] --interface [auto|asgi3|asgi2|wsgi] Select ASGI3, ASGI2, or WSGI as the application interface. [default: auto] - --env-file PATH Environment configuration file. --log-config PATH Logging configuration file. Supported formats: .ini, .json, .yaml. - --log-level [critical|error|warning|info|debug|trace] Log level. [default: info] --access-log / --no-access-log Enable/Disable access log. @@ -142,53 +134,40 @@ Options: Enable/Disable X-Forwarded-Proto, X-Forwarded-For, X-Forwarded-Port to populate remote address info. - --forwarded-allow-ips TEXT Comma seperated list of IPs to trust with proxy headers. Defaults to the $FORWARDED_ALLOW_IPS environment variable if available, or '127.0.0.1'. - --root-path TEXT Set the ASGI 'root_path' for applications submounted below a given URL path. - --limit-concurrency INTEGER Maximum number of concurrent connections or tasks to allow, before issuing HTTP 503 responses. - --backlog INTEGER Maximum number of connections to hold in backlog - --limit-max-requests INTEGER Maximum number of requests to service before terminating the process. - --timeout-keep-alive INTEGER Close Keep-Alive connections if no new data is received within this timeout. [default: 5] - --ssl-keyfile TEXT SSL key file --ssl-certfile TEXT SSL certificate file --ssl-keyfile-password TEXT SSL keyfile password --ssl-version INTEGER SSL version to use (see stdlib ssl module's) [default: 2] - --ssl-cert-reqs INTEGER Whether client certificate is required (see stdlib ssl module's) [default: 0] - --ssl-ca-certs TEXT CA certificates file --ssl-ciphers TEXT Ciphers to use (see stdlib ssl module's) [default: TLSv1] - --header TEXT Specify custom default HTTP response headers as a Name:Value pair - --version Display the uvicorn version and exit. --app-dir TEXT Look for APP in the specified directory, by adding this to the PYTHONPATH. Defaults to the current working directory. [default: .] - --factory Treat APP as an application factory, i.e. a () -> callable. [default: False] - --help Show this message and exit. ``` diff --git a/setup.py b/setup.py index 73f1771d1..cfdcb1f38 100755 --- a/setup.py +++ b/setup.py @@ -44,7 +44,7 @@ def get_packages(package): env_marker_below_38 = "python_version < '3.8'" minimal_requirements = [ - "click==7.*", + "click>=7.*", "h11>=0.8", "typing-extensions;" + env_marker_below_38, ]