Skip to content

chore: Enable experimental mode in pnpm dev for the Python CLI - #758

Merged
ilyabo merged 1 commit into
mainfrom
enable-experimental-for-pnpm-dev
Jun 22, 2026
Merged

chore: Enable experimental mode in pnpm dev for the Python CLI#758
ilyabo merged 1 commit into
mainfrom
enable-experimental-for-pnpm-dev

Conversation

@ilyabo

@ilyabo ilyabo commented Jun 22, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Collaborator

Summary

  • Pass --experimental to the Python CLI when launching pnpm dev
  • Update CLI UI and Python README examples to reflect the new dev path
  • Simplify setup docs by favoring uvx sqlrooms and uv tool install for extras

Testing

  • Not run (not requested)

Summary by CodeRabbit

  • Documentation
    • Updated development mode setup instructions for running the Python CLI server with improved clarity.
    • Modernized backend connector dependency installation examples, including options for Postgres, Snowflake, and bundled connectors.
    • Revised local smoke test procedures with updated command syntax and general verification guidance.

@coderabbitai

coderabbitai Bot commented Jun 22, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

getPythonCliDevArgs in scripts/dev.mjs is updated to always prepend --experimental to the Python dev CLI args when not already present, before conditionally adding --db-path. Both READMEs are updated to reflect this: the CLI-UI README mentions --experimental in dev mode, and the Python README removes a setup comment, revises the smoke test command, and switches connector install examples to uv tool install syntax.

Changes

--experimental flag enforcement and docs

Layer / File(s) Summary
getPythonCliDevArgs --experimental injection
scripts/dev.mjs		 Arg construction now prepends --experimental when absent in apiPortArgs before deciding whether to inject --db-path, replacing the prior logic that injected --db-path without first normalizing the experimental flag.
README documentation updates
apps/sqlrooms-cli-ui/README.md, python/sqlrooms/README.md		 CLI-UI README dev mode bullet now states the Python server runs with --experimental. Python README removes the pre-command setup comment in Quick Start, updates Manual Smoke Test to use uvx sqlrooms --no-open-browser ./smoke.duckdb with a generalized CSV-drag verification, switches Backend Connectors install examples from uv sync --extra to uv tool install "sqlrooms[...]" syntax, and fixes a blank-line boundary.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

  • sqlrooms/sqlrooms#754: Introduced the --experimental flag and experimentalEnabled gating in the Python CLI/server; this PR makes the dev script unconditionally pass that flag through getPythonCliDevArgs.

Poem

🐇 Hop hop, the flag is set,
--experimental — don't forget!
The dev args march in tidy rows,
Prepended first before --db goes.
No more missing flags in sight —
This bunny coded it just right! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The pull request title accurately describes the main change: enabling experimental mode in the Python CLI during pnpm dev execution. It is concise, clear, and directly related to the core modification across all affected files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch enable-experimental-for-pnpm-dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ilyabo ilyabo changed the title Enable experimental mode in pnpm dev for the Python CLI chore: Enable experimental mode in pnpm dev for the Python CLI Jun 22, 2026
@ilyabo
ilyabo merged commit c540c0b into main Jun 22, 2026
6 of 8 checks passed
@ilyabo
ilyabo deleted the enable-experimental-for-pnpm-dev branch June 22, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

See More

Successfully merging this pull request may close these issues.

1 participant

@ilyabo