posit-dev / posit-dev/rsconnect-python

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

オープン
#491 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

  • #497 @tdstein による — マージされずにクローズ
主要言語
Python
スター
37
フォーク
28
平均マージ
1日 3時間
マージ済み PR(30日)
7

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

rsconnect deploy コマンドのエントリーポイントから、特に既存の api サブコマンドとそのヘルプテキストを調べ始めます。コマンドがどこで登録および文書化されているかを追跡し、そのうえで flask が推奨名であること、api が後方互換性を維持していること、ヘルプテキストで Flask が明確に識別されていることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
flask, python
領域
cli
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。