posit-dev / posit-dev/rsconnect-python

Suggestion: rename `rsconnect deploy api` command to `rsconnect deploy flask`

Abierto
#491 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

  • #497 de @tdstein — cerrado sin fusionar
Lenguaje dominante
Python
Estrellas
37
Forks
28
Merge medio
1 d 3 h
PR fusionados (30 d)
7

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza en el punto de entrada del comando rsconnect deploy, especialmente en el subcomando api existente y su texto de ayuda. Rastrea dónde se registra y documenta el comando y, a continuación, verifica que flask sea el nombre recomendado, que api siga siendo compatible con versiones anteriores y que el texto de ayuda identifique claramente Flask.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
flask, python
Área
cli
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.