quality of life tweaks and --python option

Author: amol-

rsconnect/main.py

@@ -1277,14 +1277,27 @@ def info(file: str):
     type=click.Choice(AppModes.cli_aliases()),
 )
 @click.argument("name", metavar="NAME")
+@click.option(
+    "--python",
+    "python_version",
+    default=None,
+    metavar="VERSION",
+    help=(
+        "Python version for 'requires-python' in the generated pyproject.toml. "
+        "A bare 'major.minor' like '3.10' means any 3.10.x; a full '3.11.14' is "
+        "exact; pass an operator for full control (e.g. '>=3.11' or "
+        "'>=3.11,<3.14'). Defaults to '>=<major.minor>' of the interpreter "
+        "running rsconnect."
+    ),
+)
 @cli_exception_handler
-def quickstart(app_type: str, name: str):
+def quickstart(app_type: str, name: str, python_version: Optional[str]):
     # Resolve ``run_quickstart`` through the module at call time so tests can
     # monkeypatch ``rsconnect.quickstart.quickstart.run_quickstart`` without
     # binding a stale reference into ``main``'s namespace at import time.
     from .quickstart.quickstart import run_quickstart
 
-    run_quickstart(app_type=app_type, name=name)
+    run_quickstart(app_type=app_type, name=name, python_version=python_version)
 
 
 @cli.group(no_args_is_help=True, help="Deploy content to Posit Connect, Posit Cloud, or shinyapps.io.")

rsconnect/quickstart/quickstart.py

@@ -50,6 +50,7 @@ def run_quickstart(
     app_type: str,
     name: str,
     *,
+    python_version: typing.Optional[str] = None,
     cwd: typing.Optional[pathlib.Path] = None,
 ) -> pathlib.Path:
     """Scaffold a new Connect project of ``app_type`` named ``name``.
@@ -61,6 +62,12 @@ def run_quickstart(
 
     :param str app_type: one of the supported CLI types.
     :param str name: project name; must satisfy the project-name rule above.
+    :param str python_version: optional ``requires-python`` control. A value
+        that begins with a specifier operator (e.g. ``>=3.11`` or
+        ``>=3.11,<3.14``) is used verbatim. A bare version is padded to at
+        most three segments: ``3.10`` -> ``==3.10.*`` (any 3.10.x) and
+        ``3.11.14`` -> ``==3.11.14`` (exact). Defaults to ``>=<major.minor>``
+        of the interpreter running ``rsconnect``.
     :param pathlib.Path cwd: override the working directory (testing hook);
         defaults to :func:`pathlib.Path.cwd`.
     """
@@ -82,13 +89,26 @@ def run_quickstart(
     # for direct API callers only.
     spec = lookup_template(app_type)
 
+    # ``--python`` controls ``requires-python``. A value that already starts
+    # with a specifier operator (``>=3.11``, ``>=3.11,<3.14``, ...) is used
+    # verbatim. A bare version is padded to at most three segments so the
+    # ``.*`` wildcard appears only when a patch level is omitted: ``3.10`` ->
+    # ``==3.10.*`` (any 3.10.x), ``3.11.14`` -> ``==3.11.14`` (exact).
+    # Without ``--python`` we track the running interpreter's ``major.minor``.
+    if python_version is None:
+        requires_python = _REQUIRES_PYTHON
+    elif python_version[:1] in {"=", "<", ">", "!", "~"}:
+        requires_python = python_version
+    else:
+        requires_python = "==" + ".".join((python_version.split(".") + ["*"])[:3])
+
     # Atomicity: after ``mkdir`` succeeds, any failure in the rest of the
     # pipeline must remove ``./<name>/`` so the user sees "all or nothing."
     # ``BaseException`` catches ``KeyboardInterrupt`` too (a Ctrl-C
     # mid-``uv sync`` is the most likely real-world failure mode).
     target.mkdir()
     try:
-        _scaffold(target, name=name, spec=spec)
+        _scaffold(target, name=name, spec=spec, requires_python=requires_python)
         _install_venv(target)
     except BaseException:
         shutil.rmtree(target, ignore_errors=True)
@@ -335,7 +355,7 @@ def lookup_template(app_type: str) -> TemplateSpec:
 # ---------------------------------------------------------------------------
 
 
-def _scaffold(target: pathlib.Path, *, name: str, spec: TemplateSpec) -> None:
+def _scaffold(target: pathlib.Path, *, name: str, spec: TemplateSpec, requires_python: str) -> None:
     """Write every file the scaffolded project should contain.
 
     Filesystem-generation phase: the three always-present files
@@ -344,7 +364,9 @@ def _scaffold(target: pathlib.Path, *, name: str, spec: TemplateSpec) -> None:
     ``target``'s creation and rollback, so this helper writes into an
     existing directory.
     """
-    (target / "pyproject.toml").write_text(_render_pyproject(name=name, spec=spec), encoding="utf-8")
+    (target / "pyproject.toml").write_text(
+        _render_pyproject(name=name, spec=spec, requires_python=requires_python), encoding="utf-8"
+    )
     (target / ".gitignore").write_text(_GITIGNORE_BODY, encoding="utf-8")
     (target / "README.md").write_text(_render_readme(name=name, spec=spec), encoding="utf-8")
     for file_spec in spec.source_files:
@@ -389,13 +411,13 @@ def _load_template(path: str) -> str:
 """
 
 
-def _render_pyproject(*, name: str, spec: TemplateSpec) -> str:
+def _render_pyproject(*, name: str, spec: TemplateSpec, requires_python: str) -> str:
     # The per-mode template owns the literal TOML, including ``app_mode``,
     # ``entrypoint`` and the dependency list. Only ``$name`` (project name)
-    # and ``$requires_python`` (computed from the running interpreter) vary
-    # at scaffold time.
+    # and ``$requires_python`` (from ``--python`` or the running interpreter)
+    # vary at scaffold time.
     return string.Template(_load_template(spec.pyproject_template)).substitute(
-        name=name, requires_python=_REQUIRES_PYTHON
+        name=name, requires_python=requires_python
     )
 
 
@@ -450,14 +472,15 @@ def _install_venv(target: pathlib.Path) -> None:
 
 
 def _emit_summary(target: pathlib.Path, *, name: str, spec: TemplateSpec) -> None:
-    """Print the confirmation, local-run, deploy, and notes lines.
+    """Print the confirmation, cd, local-run, deploy, and notes lines.
 
     Uses :func:`click.echo` for consistency with the rest of the CLI; the
     same commands are written into the project's ``README.md`` by
     :func:`_render_readme` so stdout and on-disk docs agree.
     """
-    click.echo(f"Project {target.name}/ created.")
+    click.echo(f"\nProject {target.name}/ created.")
+    click.echo(f"To get started:  cd {name}")
     click.echo(f"To run locally:  {_format_local_run(spec, name=name)}")
-    click.echo(f"To deploy:       rsconnect deploy pyproject {name}")
+    click.echo("To deploy:       rsconnect deploy pyproject .")
     for note in spec.notes:
         click.echo(f"Note: {note}")

rsconnect/quickstart/templates/api/README.md.tmpl

@@ -11,5 +11,5 @@ uv run python -m $name
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```

rsconnect/quickstart/templates/fastapi/README.md.tmpl

@@ -11,5 +11,5 @@ uv run python -m $name
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```

rsconnect/quickstart/templates/notebook/README.md.tmpl

@@ -11,5 +11,5 @@ uv run jupyter lab notebook.ipynb
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```

rsconnect/quickstart/templates/quarto/README.md.tmpl

@@ -11,7 +11,7 @@ uv run quarto preview report.qmd
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```
 
 ## Notes

rsconnect/quickstart/templates/shiny/README.md.tmpl

@@ -11,5 +11,5 @@ uv run shiny run app.py
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```

rsconnect/quickstart/templates/streamlit/README.md.tmpl

@@ -11,5 +11,5 @@ uv run streamlit run app.py
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```

rsconnect/quickstart/templates/voila/README.md.tmpl

@@ -11,5 +11,5 @@ uv run voila notebook.ipynb
 ## Deploy to Posit Connect
 
 ```
-rsconnect deploy pyproject $name
+rsconnect deploy pyproject .
 ```

tests/test_quickstart.py

@@ -125,15 +125,19 @@ def test_quickstart_quarto_shiny_not_supported(runner: CliRunner, in_tmp_cwd: pa
     [
         (
             ["streamlit", "hello_app"],
-            {"app_type": "streamlit", "name": "hello_app"},
+            {"app_type": "streamlit", "name": "hello_app", "python_version": None},
         ),
         (
             ["notebook", "hello_notebook"],
-            {"app_type": "notebook", "name": "hello_notebook"},
+            {"app_type": "notebook", "name": "hello_notebook", "python_version": None},
         ),
         (
             ["quarto-shiny", "hello_quarto"],
-            {"app_type": "quarto-shiny", "name": "hello_quarto"},
+            {"app_type": "quarto-shiny", "name": "hello_quarto", "python_version": None},
+        ),
+        (
+            ["streamlit", "hello_app", "--python", ">=3.11"],
+            {"app_type": "streamlit", "name": "hello_app", "python_version": ">=3.11"},
         ),
     ],
 )
@@ -309,6 +313,50 @@ def test_quickstart_does_not_duplicate_deps_in_tool_rsconnect(runner: CliRunner,
     assert set(tool_rsconnect.keys()) == {"app_mode", "entrypoint", "title", "requirements_file"}
 
 
+def test_quickstart_python_option_sets_requires_python(
+    runner: CliRunner, in_tmp_cwd: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+):
+    """``--python`` overrides the detected interpreter version in ``requires-python``."""
+    monkeypatch.setattr("rsconnect.quickstart.quickstart._install_venv", lambda target: None)
+    result = _invoke_quickstart(runner, "streamlit", "--python", ">=3.10", "hello_app")
+    assert result.exit_code == 0, result.output
+    data = _read_pyproject(in_tmp_cwd / "hello_app")
+    assert data["project"]["requires-python"] == ">=3.10"
+
+
+def test_quickstart_python_option_used_verbatim(
+    runner: CliRunner, in_tmp_cwd: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+):
+    """A value starting with an operator (incl. a range) passes through unchanged."""
+    monkeypatch.setattr("rsconnect.quickstart.quickstart._install_venv", lambda target: None)
+    result = _invoke_quickstart(runner, "streamlit", "--python", ">=3.11,<3.14", "hello_app")
+    assert result.exit_code == 0, result.output
+    data = _read_pyproject(in_tmp_cwd / "hello_app")
+    assert data["project"]["requires-python"] == ">=3.11,<3.14"
+
+
+def test_quickstart_python_option_bare_version_means_any_patch(
+    runner: CliRunner, in_tmp_cwd: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+):
+    """A bare ``major.minor`` becomes ``==3.10.*`` so any 3.10.x satisfies it."""
+    monkeypatch.setattr("rsconnect.quickstart.quickstart._install_venv", lambda target: None)
+    result = _invoke_quickstart(runner, "streamlit", "--python", "3.10", "hello_app")
+    assert result.exit_code == 0, result.output
+    data = _read_pyproject(in_tmp_cwd / "hello_app")
+    assert data["project"]["requires-python"] == "==3.10.*"
+
+
+def test_quickstart_python_option_full_version_is_exact(
+    runner: CliRunner, in_tmp_cwd: pathlib.Path, monkeypatch: pytest.MonkeyPatch
+):
+    """A full ``major.minor.patch`` becomes ``==3.11.14`` (exact, no trailing ``.*``)."""
+    monkeypatch.setattr("rsconnect.quickstart.quickstart._install_venv", lambda target: None)
+    result = _invoke_quickstart(runner, "streamlit", "--python", "3.11.14", "hello_app")
+    assert result.exit_code == 0, result.output
+    data = _read_pyproject(in_tmp_cwd / "hello_app")
+    assert data["project"]["requires-python"] == "==3.11.14"
+
+
 # ---------------------------------------------------------------------------
 # Per-mode app_mode matrix
 # ---------------------------------------------------------------------------
@@ -625,8 +673,9 @@ def test_quickstart_post_scaffold_output(
     lines = [line for line in result.output.splitlines() if line.strip()]
     expected = [
         "Project hello_app/ created.",
+        "To get started:  cd hello_app",
         f"To run locally:  {local_run}",
-        "To deploy:       rsconnect deploy pyproject hello_app",
+        "To deploy:       rsconnect deploy pyproject .",
         *extra_lines,
     ]
     assert lines == expected, result.output
@@ -638,7 +687,7 @@ def test_quickstart_readme_matches_post_scaffold_output(runner: CliRunner, in_tm
     readme = (in_tmp_cwd / "hello_app" / "README.md").read_text()
     # The README and stdout agree on the two commands the user needs.
     assert "uv run streamlit run app.py" in readme
-    assert "rsconnect deploy pyproject hello_app" in readme
+    assert "rsconnect deploy pyproject ." in readme
 
 
 def test_quickstart_quarto_readme_includes_install_note(runner: CliRunner, in_tmp_cwd: pathlib.Path):