posit-dev / posit-dev/rsconnect-python

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

Aperta
#491 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

  • #497 di @tdstein — chiusa senza merge
Lingua principale
Python
Stelle
37
Fork
28
Merge medio
1g 3h
PR unite (30g)
7

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dal punto di ingresso del comando rsconnect deploy, in particolare dal subcomando api esistente e dal relativo testo di aiuto. Traccia dove viene registrato e documentato il comando, quindi verifica che flask sia il nome consigliato, che api rimanga retrocompatibile e che il testo di aiuto identifichi chiaramente Flask.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
flask, python
Ambito
cli
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.