Adds 'flask', 'asgi', and 'wsgi' options as aliases to 'api' and 'fastapi'.

Author: tdstein

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## Unreleased
 
 ### Fixed
@@ -20,6 +21,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   and `*_app.py` are now considered. However, if the directory contains more than
   one file matching these new patterns, you must provide rsconnect-python with an
   explicit `--entrypoint` argument.
+- Added the `deploy asgi` command.
+- Added the `deploy flask` command.
+- Added the `deploy wsgi` command.
+- Added the `deploy asgi` command.
+- Added the `deploy wsgi` command.
+- Added the `deploy flask` command.
+
+### Removed
+- Deprecated the `deploy api` command.
+- Deprecated the `write-manifest api` command.
 
 ## [1.20.0] - 2023-09-11
 

README.md

@@ -117,7 +117,7 @@ you will need to include the `--cacert` option that points to your certificate
 authority (CA) trusted certificates file. Both of these options can be saved along
 with the URL and API Key for a server.
 
-> **Note** 
+> **Note**
 > When certificate information is saved for the server, the specified file
 > is read and its _contents_ are saved under the server's nickname. If the CA file's
 > contents are ever changed, you will need to add the server information again.
@@ -135,7 +135,7 @@ rsconnect add \
     --name myserver
 ```
 
-> **Note** 
+> **Note**
 > The `rsconnect` CLI will verify that the serve URL and API key
 > are valid. If either is found not to be, no information will be saved.
 
@@ -270,14 +270,13 @@ rsconnect write-manifest notebook my-notebook.ipynb
 You can deploy a variety of APIs and applications using sub-commands of the
 `rsconnect deploy` command.
 
-* `api`: WSGI-compliant APIs such as Flask and packages based on Flask
-* `fastapi`: ASGI-compliant APIs (FastAPI, Quart, Sanic, and Falcon)
-* `dash`: Python Dash apps
-* `streamlit`: Streamlit apps
-* `bokeh`: Bokeh server apps
-
-All options below apply equally to the `api`, `fastapi`, `dash`, `streamlit`,
-and `bokeh` sub-commands.
+* `wsgi`: [WSGI (PEP 3333)](https://peps.python.org/pep-3333/) compliant applications such as Bottle, Flask, and Pycnic.
+* `asgi`: [ASGI](https://asgi.readthedocs.io/en/latest/specs/main.html) compliant applications such as Falcon, FastAPI, Quart, and Sanic.
+* `bokeh`: Bokeh server applications.
+* `dash`: Dash appliations.
+* `fastapi`: FastAPI applications.
+* `flask`: Flask applications.
+* `streamlit`: Streamlit applications.
 
 #### Including Extra Files
 
@@ -286,7 +285,7 @@ API or application is run by the Posit Connect server. Just specify them on the
 command line after the API or application directory:
 
 ```bash
-rsconnect deploy api flask-api/ data.csv
+rsconnect deploy flask flask-api/ data.csv
 ```
 
 Since deploying an API or application starts at a directory level, there will be times
@@ -351,7 +350,7 @@ the package dependencies will be determined from the current Python environment,
 from an alternative Python executable specified via the `--python` option:
 
 ```bash
-rsconnect deploy api --python /path/to/python my-api/
+rsconnect deploy wsgi --python /path/to/python my-api/
 ```
 
 You can see the packages list that will be included by running `pip list --format=freeze` yourself,
@@ -374,7 +373,7 @@ Python executable specified in the `--python` option.
 Here is an example of the `write-manifest` command:
 
 ```bash
-rsconnect write-manifest api my-api/
+rsconnect write-manifest wsgi my-api/
 ```
 
 ### Deploying R or Other Content
@@ -421,7 +420,7 @@ this, use the `--title` option:
 rsconnect deploy notebook --title "My Notebook" my-notebook.ipynb
 ```
 
-When using `rsconnect deploy api`, `rsconnect deploy fastapi`, `rsconnect deploy dash`,
+When using `rsconnect deploy wsgi`, `rsconnect deploy asgi`, `rsconnect deploy flask`, `rsconnect deploy fastapi`, `rsconnect deploy dash`,
 `rsconnect deploy streamlit`, or `rsconnect deploy bokeh`, the title is derived from the directory
 containing the API or application.
 
@@ -430,7 +429,7 @@ filename referenced in the manifest.
 
 ### Environment variables
 You can set environment variables during deployment. Their names and values will be
-passed to Posit Connect during deployment so you can use them in your code. Note that 
+passed to Posit Connect during deployment so you can use them in your code. Note that
 if you are using `rsconnect` to deploy to shinyapps.io, environment variable management
 is not supported on that platform.
 
@@ -985,9 +984,9 @@ xargs printf -- '-g %s\n' < guids.txt | xargs rsconnect content build add
 ```
 ## Programmatic Provisioning
 
-Posit Connect supports the programmatic bootstrapping of an administrator API key 
+Posit Connect supports the programmatic bootstrapping of an administrator API key
 for scripted provisioning tasks. This process is supported by the `rsconnect bootstrap` command,
-which uses a JSON Web Token to request an initial API key from a fresh Connect instance. 
+which uses a JSON Web Token to request an initial API key from a fresh Connect instance.
 
 > **Warning**
 > This feature **requires Python version 3.6 or higher**.
@@ -998,7 +997,7 @@ rsconnect bootstrap \
     --jwt-keypath /path/to/secret.key
 ```
 
-A full description on how to use `rsconnect bootstrap` in a provisioning workflow is provided in the Connect administrator guide's 
+A full description on how to use `rsconnect bootstrap` in a provisioning workflow is provided in the Connect administrator guide's
 [programmatic provisioning](https://docs.posit.co/connect/admin/programmatic-provisioning) documentation.
 
 ## Server Administration Tasks

rsconnect/main.py

@@ -8,6 +8,7 @@
 import click
 from os.path import abspath, dirname, exists, isdir, join
 from functools import wraps
+from typing import Optional
 
 from rsconnect.certificates import read_certificate_file
 
@@ -65,6 +66,7 @@
 from .log import logger, LogOutputFormat
 from .metadata import ServerStore, AppStore
 from .models import (
+    AppMode,
     AppModes,
     BuildStatus,
     ContentGuidWithBundleParamType,
@@ -1281,19 +1283,28 @@ def deploy_html(
     )
 
 
-def generate_deploy_python(app_mode, alias, min_version):
+def generate_deploy_python(app_mode: AppMode, alias: str, min_version: str, deprecated: bool = False, desc: Optional[str] = None):
+
+    if desc is None:
+        desc = app_mode.desc()
+
+    help=(
+        "Deploy a {desc} module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). "
+        'The "directory" argument must refer to an existing directory that contains the application code.'
+    ).format(desc=desc)
+
+    short_help="Deploy a {desc} to Posit Connect [v{version}+], Posit Cloud, or shinyapps.io.".format(
+        desc=desc,
+        version=min_version,
+    )
+
     # noinspection SpellCheckingInspection
     @deploy.command(
         name=alias,
-        short_help="Deploy a {desc} to Posit Connect [v{version}+], Posit Cloud, or shinyapps.io.".format(
-            desc=app_mode.desc(),
-            version=min_version,
-        ),
-        help=(
-            "Deploy a {desc} module to Posit Connect, Posit Cloud, or shinyapps.io (if supported by the platform). "
-            'The "directory" argument must refer to an existing directory that contains the application code.'
-        ).format(desc=app_mode.desc()),
+        short_help=short_help,
+        help=help,
         no_args_is_help=True,
+        deprecated=deprecated,
     )
     @server_args
     @content_args
@@ -1407,14 +1418,15 @@ def deploy_app(
     return deploy_app
 
 
-deploy_api = generate_deploy_python(app_mode=AppModes.PYTHON_API, alias="api", min_version="1.8.2")
-# TODO: set fastapi min_version correctly
-# deploy_fastapi = generate_deploy_python(app_mode=AppModes.PYTHON_FASTAPI, alias="fastapi", min_version="2021.08.0")
-deploy_fastapi = generate_deploy_python(app_mode=AppModes.PYTHON_FASTAPI, alias="fastapi", min_version="2021.08.0")
-deploy_dash_app = generate_deploy_python(app_mode=AppModes.DASH_APP, alias="dash", min_version="1.8.2")
-deploy_streamlit_app = generate_deploy_python(app_mode=AppModes.STREAMLIT_APP, alias="streamlit", min_version="1.8.4")
-deploy_bokeh_app = generate_deploy_python(app_mode=AppModes.BOKEH_APP, alias="bokeh", min_version="1.8.4")
-deploy_shiny = generate_deploy_python(app_mode=AppModes.PYTHON_SHINY, alias="shiny", min_version="2022.07.0")
+generate_deploy_python(app_mode=AppModes.PYTHON_API, alias="api", min_version="1.8.2", desc="API Application", deprecated=True)
+generate_deploy_python(app_mode=AppModes.PYTHON_API, alias="wsgi", min_version="1.8.2", desc="WSGI Application")
+generate_deploy_python(app_mode=AppModes.PYTHON_API, alias="flask", min_version="1.8.2", desc="Flask Application")
+generate_deploy_python(app_mode=AppModes.PYTHON_FASTAPI, alias="asgi", min_version="2021.08.0", desc="ASGI Application")
+generate_deploy_python(app_mode=AppModes.PYTHON_FASTAPI, alias="fastapi", min_version="2021.08.0", desc="FastAPI Application")
+generate_deploy_python(app_mode=AppModes.DASH_APP, alias="dash", min_version="1.8.2")
+generate_deploy_python(app_mode=AppModes.STREAMLIT_APP, alias="streamlit", min_version="1.8.4")
+generate_deploy_python(app_mode=AppModes.BOKEH_APP, alias="bokeh", min_version="1.8.4")
+generate_deploy_python(app_mode=AppModes.PYTHON_SHINY, alias="shiny", min_version="2022.07.0")
 
 
 @deploy.command(
@@ -1759,24 +1771,28 @@ def write_manifest_quarto(
         )
 
 
-def generate_write_manifest_python(app_mode, alias):
+def generate_write_manifest_python(app_mode, alias, desc: Optional[str] = None, deprecated: bool = False):
+    if desc is None:
+        desc = app_mode.desc()
+
     # noinspection SpellCheckingInspection
     @write_manifest.command(
         name=alias,
-        short_help="Create a manifest.json file for a {desc}.".format(desc=app_mode.desc()),
+        short_help="Create a manifest.json file for a {desc}.".format(desc=desc),
         help=(
             "Create a manifest.json file for a {desc} for later deployment. This will create an "
             'environment file ("requirements.txt") if one does not exist. All files '
             "are created in the same directory as the API code."
-        ).format(desc=app_mode.desc()),
+        ).format(desc=desc),
+        deprecated=deprecated,
     )
     @click.option("--overwrite", "-o", is_flag=True, help="Overwrite manifest.json, if it exists.")
     @click.option(
         "--entrypoint",
         "-e",
         help=(
             "The module and executable object which serves as the entry point for the {desc} (defaults to app)"
-        ).format(desc=app_mode.desc()),
+        ).format(desc=desc),
     )
     @click.option(
         "--exclude",
@@ -1850,12 +1866,15 @@ def manifest_writer(
     return manifest_writer
 
 
-write_manifest_api = generate_write_manifest_python(AppModes.PYTHON_API, alias="api")
-write_manifest_fastapi = generate_write_manifest_python(AppModes.PYTHON_FASTAPI, alias="fastapi")
-write_manifest_dash = generate_write_manifest_python(AppModes.DASH_APP, alias="dash")
-write_manifest_streamlit = generate_write_manifest_python(AppModes.STREAMLIT_APP, alias="streamlit")
-write_manifest_bokeh = generate_write_manifest_python(AppModes.BOKEH_APP, alias="bokeh")
-write_manifest_shiny = generate_write_manifest_python(AppModes.PYTHON_SHINY, alias="shiny")
+generate_write_manifest_python(AppModes.BOKEH_APP, alias="bokeh")
+generate_write_manifest_python(AppModes.DASH_APP, alias="dash")
+generate_write_manifest_python(AppModes.PYTHON_API, alias="api", desc="API Application", deprecated=True)
+generate_write_manifest_python(AppModes.PYTHON_API, alias="wsgi", desc="WSGI Application")
+generate_write_manifest_python(AppModes.PYTHON_API, alias="flask", desc="Flask Application")
+generate_write_manifest_python(AppModes.PYTHON_FASTAPI, alias="asgi", desc="ASGI Application")
+generate_write_manifest_python(AppModes.PYTHON_FASTAPI, alias="fastapi", desc="FastAPI Application")
+generate_write_manifest_python(AppModes.PYTHON_SHINY, alias="shiny")
+generate_write_manifest_python(AppModes.STREAMLIT_APP, alias="streamlit")
 
 
 # noinspection SpellCheckingInspection