feat: Standalone FastAPI web server adapter (env="fastapi") to bypass Jupyter dependencies#741
Open
Sagar369r wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e0ef3e0398
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(Note to maintainers: This PR is independent of and compatible with my Polars data parser optimization PR #740).
Summary of Changes
Currently,
PyGWalkerentry points (pygwalker.walk()) rely heavily onIPython.displayand Jupyter kernel inter-process communication (IPC) channels. This makes it challenging to embedPyGWalkerinside standalone Python web servers, headless environments, or custom desktop applications without pulling in full Jupyter dependencies.This PR introduces a lightweight, standalone FastAPI server and CLI adapter under
pygwalker.api.server(env="fastapi"):Key Capabilities
walk_server(df)Adapter (pygwalker/api/server.py): BypassesIPython.displayentirely. Configuresprops["communicationUrl"] = "/comm"and serves the raw_get_render_iframe(return_iframe=False)HTML directly over an async FastAPI web server./commBridge: Maps Graphic-Walker JSON communication requests (POST /comm) directly toPygWalker.comm._receive_msg()without going through Jupyter widgets oranywidgettransport layers.pygwalker/api/cli.py): Exposes an internal terminal command (pygwalker-cli <file>) for instant local exploration.pip install pygwalker[server]), keeping the default installation lightweight for standard notebook users.Verification & Compatibility Proof
test_pygwalker_core.pyandtest_computation.pysuites (114 passed) execute without issue, ensuring zero regressions forenv="jupyter",env="streamlit", orenv="gradio".PolarsDataFrameDataParseror any standard data parser.