posit-dev / posit-dev/rsconnect-python
Suggestion: rename `rsconnect deploy api` command to `rsconnect deploy flask`
Open
Nobody has claimed this yet.
- #497 by @tdstein — closed without merging
- Dominant language
- Python
- Stars
- 37
- Forks
- 28
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 7
Description
The rsconnect deploy command has the following options:
$ rsconnect deploy --help
Usage: rsconnect deploy [OPTIONS] COMMAND [ARGS]...
Deploy content to Posit Connect, Posit Cloud, or shinyapps.io.
Options:
--help Show this message and exit.
Commands:
api Deploy a Python API to Posit Connect [v1.8.2+], Posit Cloud,
or shinyapps.io.
bokeh Deploy a Bokeh Application to Posit Connect [v1.8.4+], Posit
Cloud, or shinyapps.io.
dash Deploy a Dash Application to Posit Connect [v1.8.2+], Posit
Cloud, or shinyapps.io.
fastapi Deploy a Python FastAPI to Posit Connect [v2021.08.0+], Posit
Cloud, or shinyapps.io.
html Deploy html content to Posit Connect or Posit Cloud.
manifest Deploy content to Posit Connect, Posit Cloud, or shinyapps.io
by manifest.
notebook Deploy Jupyter notebook to Posit Connect [v1.7.0+].
other-content Describe deploying other content to Posit Connect.
quarto Deploy Quarto content to Posit Connect [v2021.08.0+] or Posit
Cloud.
shiny Deploy a Python Shiny Application to Posit Connect
[v2022.07.0+], Posit Cloud, or shinyapps.io.
streamlit Deploy a Streamlit Application to Posit Connect [v1.8.4+],
Posit Cloud, or shinyapps.io.
voila Deploy Jupyter notebook in Voila mode to Posit Connect
[v2023.03.0+].
I propose renaming rsconnect deploy api to rsconnect deploy flask.
- Now that FastAPI is supported, it is confusing that the command to deploy a flask API is called
api(all of the other deploy commands use the framework name). - The help message is also confusing and does not mention Flask (e.g.
Deploy a Python API to Posit Connect [v1.8.2+], Posit Cloud, or shinyapps.io.. It is unclear to users what a "Python API" is. - This can be done so that backwards compatibility is not broken, but we only document and recommend
rsconnect deploy flask.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the rsconnect deploy command entry point, especially the existing api subcommand and its help text. Trace where the command is registered and documented, then verify that flask is the recommended name, api remains backward compatible, and the help text identifies Flask clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask, python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100