setup svelte ui

Author: softwareentrepreneer

.gitattributes

@@ -1 +1,3 @@
 *.ipynb -linguist-detectable
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.gitignore

@@ -187,3 +187,9 @@ docs/_build/*
 
 # tests data
 tests/data/
+
+# pixi environments
+.pixi
+*.egg-info
+
+.python-version

README.md

@@ -29,7 +29,7 @@ We created a high-level plotting library that combines the best features from ex
 
 ---
 
-PFund-Plot is a super high-level, out-of-the-box, domain-specific plotting library designed for traders that supports **financial data visualization**, **dashboard creation**, and **template sharing**.
+`pfund-plot` is a super high-level, out-of-the-box, domain-specific plotting library designed for traders, supporting **financial data visualization**, **dashboard creation**, and **template sharing**.
 
 
 ## Core Features
@@ -55,5 +55,5 @@ import pfund_plot as plt
 feed = pe.YahooFinanceFeed()
 df = feed.get_historical_data(product='AAPL_USD_STK', resolution='1d', rollback_period='1y')
 
-fig = plt.ohlc(df, display_mode='browser', streaming=False)
+fig = plt.ohlc(df, mode='browser', streaming=False)
 ```

docs/getting-started/quickstart/candlestick.ipynb

@@ -9,7 +9,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -144,13 +144,18 @@
     "feed = pe.YahooFinanceFeed(data_tool='pandas')\n",
     "df = feed.get_historical_data(product='AAPL_USD_STK', resolution='1d', rollback_period='1y')\n",
     "\n",
-    "fig = plt.ohlc(df, display_mode='notebook', streaming=False)"
+    "fig = plt.ohlc(df, display_mode='notebook', streaming=False)\n",
+    "fig"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 4,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "hide-cell"
+    ]
+   },
    "outputs": [
     {
      "data": {

pfund_plot/layout.py

@@ -17,13 +17,13 @@
 @contextmanager
 def layout(
     streaming: bool = False,
-    display_mode: Literal['browser', 'desktop'] = 'browser', 
+    mode: Literal['browser', 'desktop'] = 'browser', 
     num_cols: int = 3,
     allow_drag: bool = True,
     # FIXME: plots can't be resized when using GridStack, not sure if it's a bottleneck or a bug
     # allow_resize: bool = True,
 ):
-    assert display_mode.lower() in ['browser', 'desktop'], "display_mode must be 'browser' or 'desktop'"
+    assert mode.lower() in ['browser', 'desktop'], "mode must be 'browser' or 'desktop'"
 
     # Setup state
     state.layout.in_layout = True
@@ -36,7 +36,7 @@ def layout(
         components = state.layout.components
         return _layout_plot(
             *components,
-            display_mode=display_mode,
+            mode=mode,
             num_cols=num_cols,
             allow_drag=allow_drag,
             # allow_resize=allow_resize,
@@ -45,7 +45,7 @@ def layout(
 
 def _layout_plot(
     *figs: tFigure,
-    display_mode: Literal['browser', 'desktop'] = 'browser',
+    mode: Literal['browser', 'desktop'] = 'browser',
     num_cols: int = 3,
     allow_drag: bool = True,
     # allow_resize: bool = False,
@@ -71,4 +71,4 @@ def _layout_plot(
 
     periodic_callbacks = state.layout.periodic_callbacks
     state.reset_layout()
-    return render(gstack, display_mode, periodic_callbacks=periodic_callbacks)
+    return render(gstack, mode, periodic_callbacks=periodic_callbacks)

pfund_plot/plots/candlestick.py

@@ -94,7 +94,7 @@ def _create_hover_tool(df: Frame) -> HoverTool:
 def candlestick_plot(
     data: GenericFrame | BaseFeed, 
     streaming: bool = False, 
-    display_mode: tDISPLAY_MODE = "notebook", 
+    mode: tDISPLAY_MODE = "notebook", 
     num_data: int = 100,
     raw_figure: bool = False,
     slider_step: int = 100,
@@ -112,7 +112,7 @@ def candlestick_plot(
     Args:
         data: the data to plot, either a dataframe or pfeed's feed object
         streaming: if True, the plot will be updated in real-time as new data is received
-        display_mode: where to display the plot, either "notebook", "browser", or "desktop"
+        mode: where to display the plot, either "notebook", "browser", or "desktop"
         streaming_freq: the update frequency of the streaming data in milliseconds
         raw_figure: if True, returns the raw figure object (e.g. bokeh.plotting.figure or plotly.graph_objects.Figure)
             if False, returns the holoviews.core.overlay.Overlay object
@@ -130,7 +130,7 @@ def candlestick_plot(
     # TODO: using tick data to update the current candlestick
 
 
-    display_mode = DisplayMode[display_mode.lower()]
+    mode = DisplayMode[mode.lower()]
     if state.layout.in_layout:
         streaming = streaming or state.layout.streaming
     data_type: DataType = validate_data_type(data, streaming, import_hvplot=True)
@@ -141,7 +141,7 @@ def candlestick_plot(
     else:
         df = data
     df: Frame = _validate_df(df)
-    if display_mode == DisplayMode.notebook:
+    if mode == DisplayMode.notebook:
         height = height or DEFAULT_HEIGHT_FOR_NOTEBOOK
 
 
@@ -239,4 +239,4 @@ def _update_plot():
             height=height,
             width=width,
         )
-        return render(fig, display_mode, periodic_callbacks=[periodic_callback])
+        return render(fig, mode, periodic_callbacks=[periodic_callback])

pfund_plot/plots/dataframe.py

@@ -35,7 +35,7 @@
 # EXTEND: maybe add some common functionalities here, e.g. search, sort, filter etc. not sure what users want for now.
 def dataframe_plot(
     data: GenericFrame | BaseFeed,
-    display_mode: tDISPLAY_MODE = "notebook",
+    mode: tDISPLAY_MODE = "notebook",
     backend: tDATAFRAME_BACKEND = "tabulator",
     streaming: bool = False,
     streaming_freq: int = 1000,  # in milliseconds
@@ -50,7 +50,7 @@ def dataframe_plot(
     '''
     Args:
         data: the data to plot, either a dataframe or pfeed's feed object
-        display_mode: where to display the plot, either "notebook", "browser", or "desktop"
+        mode: where to display the plot, either "notebook", "browser", or "desktop"
         streaming: if True, the plot will be updated in real-time as new data is received
         streaming_freq: the update frequency of the streaming data in milliseconds
         max_streaming_data: maximum number of data points used when streaming.
@@ -71,7 +71,7 @@ def dataframe_plot(
     and https://panel.holoviz.org/reference/panes/Perspective.html for Perspective backend.
     '''
 
-    display_mode, backend = DisplayMode[display_mode.lower()], DataFrameBackend[backend.lower()]
+    mode, backend = DisplayMode[mode.lower()], DataFrameBackend[backend.lower()]
     if state.layout.in_layout:
         streaming = streaming or state.layout.streaming
     data_type: DataType = validate_data_type(data, streaming, import_hvplot=False)
@@ -84,7 +84,7 @@ def dataframe_plot(
     df = convert_to_pandas_df(df)
 
     use_iframe_in_notebook, iframe_style = False, None
-    if display_mode == DisplayMode.notebook:
+    if mode == DisplayMode.notebook:
         use_iframe_in_notebook = (backend == DataFrameBackend.perspective)
         height = height or DEFAULT_HEIGHT_FOR_NOTEBOOK
     if 'sizing_mode' not in kwargs:
@@ -101,7 +101,7 @@ def dataframe_plot(
             max_streaming_data = SUGGESTED_MIN_STREAMING_DATA_FOR_TABULATOR
         notebook_type: NotebookType = get_notebook_type()
         # FIXME: this is a workaround for a bug in panel Tabulator, see if panel will fix it, or create a github issue
-        if display_mode == DisplayMode.notebook and notebook_type in [NotebookType.jupyter, NotebookType.marimo]:
+        if mode == DisplayMode.notebook and notebook_type in [NotebookType.jupyter, NotebookType.marimo]:
             pagination = 'remote'
         else:
             pagination = 'local'
@@ -166,7 +166,7 @@ def _update_table():
 
     return render(
         table, 
-        display_mode, 
+        mode, 
         periodic_callbacks=[periodic_callback], 
         use_iframe_in_notebook=use_iframe_in_notebook,
         iframe_style=iframe_style,

pfund_plot/plots/orderbook.py

@@ -20,7 +20,7 @@
 # TODO: use perspective to plot orderbook
 def orderbook_plot(
     data: GenericFrame | BaseFeed,
-    display_mode: tDISPLAY_MODE = 'notebook',
+    mode: tDISPLAY_MODE = 'notebook',
     streaming: bool = False,
     streaming_freq: int = 1000,  # in milliseconds
     height: int = 600,
@@ -29,15 +29,15 @@ def orderbook_plot(
     '''
     Args:
         height: height of the orderbook plot in pixels.
-            Only applicable when display_mode is 'notebook'.
+            Only applicable when mode is 'notebook'.
         kwargs: kwargs for pn.pane.Perspective
 
     For all the supported kwargs, and more customization examples,
     please refer to https://panel.holoviz.org/reference/panes/Perspective.html.
     '''
     return dataframe_plot(
         data, 
-        display_mode=display_mode,
+        mode=mode,
         streaming=streaming,
         streaming_freq=streaming_freq,
         backend='perspective', 

pfund_plot/renderer.py

@@ -65,7 +65,7 @@ def run_callbacks(periodic_callbacks: list[PeriodicCallback], notebook_type: Not
 
 def render(
     fig: Panel | Pane | Widget,
-    display_mode: Literal["notebook", "browser", "desktop"] | DisplayMode,
+    mode: Literal["notebook", "browser", "desktop"] | DisplayMode,
     periodic_callbacks: list[PeriodicCallback] | PeriodicCallback | None = None,
     use_iframe_in_notebook: bool = False,
     iframe_style: str | None = None,
@@ -74,7 +74,7 @@ def render(
     Args:
         fig: the figure to render.
             supports plots from "hvplot", "holoviews" and panels, panes or widgets from "panel"
-        display_mode: the mode to display the plot.
+        mode: the mode to display the plot.
             supports "notebook", "browser" and "desktop"
         plotting_backend: the backend to use for rendering the figure.
             supports "bokeh" and "plotly"
@@ -84,8 +84,8 @@ def render(
             It is a workaround when the plot can't be displayed in a notebook.
         iframe_style: the style of the iframe when use_iframe_in_notebook is True.
     '''
-    if isinstance(display_mode, str):
-        display_mode = DisplayMode[display_mode.lower()]    
+    if isinstance(mode, str):
+        mode = DisplayMode[mode.lower()]    
 
     if isinstance(periodic_callbacks, PeriodicCallback):
         periodic_callbacks = [periodic_callbacks]
@@ -94,7 +94,7 @@ def render(
     # NOTE: handling differs between notebook environment and python script
     is_notebook_env = (notebook_type is not None)
 
-    if display_mode == DisplayMode.notebook:
+    if mode == DisplayMode.notebook:
         if not use_iframe_in_notebook:
             panel_fig: Panel | Pane | Widget = fig
             run_callbacks(periodic_callbacks, notebook_type)
@@ -121,22 +121,22 @@ def render(
             if is_notebook_env:
                 server: StoppableThread = pn.serve(fig, show=False, threaded=True, port=port)
                 run_callbacks(periodic_callbacks, notebook_type)
-            else:  # only happens when running layout_plot() where components are all using display_mode="notebook" in a python script 
+            else:  # only happens when running layout_plot() where components are all using mode="notebook" in a python script 
                 def run_server():
                     run_callbacks(periodic_callbacks, notebook_type)
                     pn.serve(fig, show=False, threaded=True, port=port)  # this will block the main thread
                 thread = Thread(target=run_server, daemon=True)
                 thread.start()
         return panel_fig
-    elif display_mode == DisplayMode.browser:
+    elif mode == DisplayMode.browser:
         if is_notebook_env:
             server: StoppableThread = pn.serve(fig, show=True, threaded=True)
             run_callbacks(periodic_callbacks, notebook_type)
             return server
         else:  # run in a python script
             run_callbacks(periodic_callbacks, notebook_type)
             pn.serve(fig, show=True, threaded=False)  # this will block the main thread
-    elif display_mode == DisplayMode.desktop:
+    elif mode == DisplayMode.desktop:
         port = get_free_port()
         title = getattr(fig, 'name', "PFund Plot")
         window_ready = Event()
@@ -168,4 +168,4 @@ def run_server():
             thread.start()
             process.join()
     else:
-        raise ValueError(f"Invalid display mode: {display_mode}")
+        raise ValueError(f"Invalid display mode: {mode}")