pfund-plot 0.0.1__py3-none-any.whl

pfund_plot/__init__.py

@@ -0,0 +1,183 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pfund_plot.plots.altair import (
+        Altair as altair,
+    )
+    from pfund_plot.plots.altair import (
+        Altair as vega,
+    )
+    from pfund_plot.plots.area import (
+        Area as area,
+    )
+    from pfund_plot.plots.bar import (
+        Bar as bar,
+    )
+    from pfund_plot.plots.bokeh import (
+        Bokeh as bokeh,
+    )
+    from pfund_plot.plots.candlestick import (
+        Candlestick as candlestick,
+    )
+    from pfund_plot.plots.candlestick import (
+        Candlestick as kline,
+    )
+    from pfund_plot.plots.candlestick import (
+        Candlestick as ohlc,
+    )
+    from pfund_plot.plots.holoviews import (
+        Holoviews as holoviews,
+    )
+    from pfund_plot.plots.holoviews import (
+        Holoviews as hv,
+    )
+    from pfund_plot.plots.label import (
+        Label as label,
+    )
+    from pfund_plot.plots.layout import (
+        Layout as layout,
+    )
+    from pfund_plot.plots.layout.tabs import (
+        Tabs as tabs,
+    )
+    from pfund_plot.plots.line import (
+        Line as line,
+    )
+    from pfund_plot.plots.matplotlib import (
+        Matplotlib as matplotlib,
+    )
+    from pfund_plot.plots.matplotlib import (
+        Matplotlib as mpl,
+    )
+    from pfund_plot.plots.plotly import (
+        Plotly as plotly,
+    )
+    from pfund_plot.plots.scatter import (
+        Scatter as scatter,
+    )
+    from pfund_plot.plots.scatter.marker import (
+        Marker as marker,
+    )
+
+# NOTE: data update in anywidget (backend=svelte) may have issues (especially in marimo) after loading panel extensions
+# if anywidget+svelte backend is not working, try to comment this out
+#
+# plotly/vega resolve to panel.models.* (bundled with Panel) — they don't import the
+# plotly/altair libs, so they're safe even when those optional extras aren't installed.
+# "ipywidgets" pulls in panel.io.ipywidget -> ipywidgets_bokeh, which is absent in WASM
+# (and where the anywidget/svelte backend isn't available anyway), so guard only that one.
+import importlib.util
+
+import panel as pn
+
+from pfund_plot.config import configure, get_config
+
+_panel_extensions = ["plotly", "vega"]
+if importlib.util.find_spec("ipywidgets_bokeh") is not None:
+    _panel_extensions.append("ipywidgets")
+pn.extension(*_panel_extensions)
+# NOTE: this MUST be True, otherwise, some widgets won't work properly, e.g. candlestick widgets, slider and input will both trigger each other due to panel's async update, which leads to infinite loop.
+pn.config.throttled = (
+    True  # If panel sliders and inputs should be throttled until release of mouse.
+)
+# NOTE: /assets can only be recognized when setting pn.serve(static_dirs=pfund_plot.config.static_dirs)
+# see static_dirs in config.py
+# pn.config.js_files = {
+#     "your_custom_js_file": "/assets/your_custom_js_file.js",
+# }
+
+
+def __getattr__(name: str):
+    if name == "__version__":
+        from importlib.metadata import version
+
+        return version("pfund_plot")
+    elif name == "plotly":
+        from pfund_plot.plots.plotly import Plotly
+
+        return Plotly
+    elif name in ("candlestick", "ohlc", "kline"):
+        from pfund_plot.plots.candlestick import Candlestick
+
+        return Candlestick
+    elif name == "line":
+        from pfund_plot.plots.line import Line
+
+        return Line
+    elif name == "area":
+        from pfund_plot.plots.area import Area
+
+        return Area
+    elif name == "layout":
+        from pfund_plot.plots.layout import Layout
+
+        return Layout
+    elif name == "tabs":
+        from pfund_plot.plots.layout.tabs import Tabs
+
+        return Tabs
+    elif name == "scatter":
+        from pfund_plot.plots.scatter import Scatter
+
+        return Scatter
+    elif name == "marker":
+        from pfund_plot.plots.scatter.marker import Marker
+
+        return Marker
+    elif name == "label":
+        from pfund_plot.plots.label import Label
+
+        return Label
+    elif name == "bar":
+        from pfund_plot.plots.bar import Bar
+
+        return Bar
+    elif name in ("altair", "vega"):
+        from pfund_plot.plots.altair import Altair
+
+        return Altair
+    elif name in ("matplotlib", "mpl"):
+        from pfund_plot.plots.matplotlib import Matplotlib
+
+        return Matplotlib
+    elif name == "bokeh":
+        from pfund_plot.plots.bokeh import Bokeh
+
+        return Bokeh
+    elif name in ("holoviews", "hv"):
+        from pfund_plot.plots.holoviews import Holoviews
+
+        return Holoviews
+    else:
+        raise AttributeError(f"'{__name__}' has no attribute '{name}'")
+
+
+__all__ = (
+    "altair",
+    "area",
+    "bar",
+    "bokeh",
+    "candlestick",
+    "configure",
+    "get_config",
+    "holoviews",
+    "hv",
+    "kline",
+    "label",
+    "layout",
+    "line",
+    "marker",
+    "matplotlib",
+    "mpl",
+    "ohlc",
+    "plotly",
+    "scatter",
+    "tabs",
+    "vega",
+)
+
+
+def __dir__():
+    return sorted(__all__)

pfund_plot/__main__.py

@@ -0,0 +1,9 @@
+def run_cli() -> None:
+    """Application Entrypoint."""
+    from pfund_plot.cli import pfund_plot_group
+
+    pfund_plot_group(obj={})
+
+
+if __name__ == "__main__":
+    run_cli()

pfund_plot/cli/__init__.py

@@ -0,0 +1,3 @@
+from pfund_plot.cli.main import pfund_plot_group
+
+__all__ = ["pfund_plot_group"]

pfund_plot/cli/commands/gallery/__init__.py

@@ -0,0 +1,15 @@
+import subprocess
+import sys
+from pathlib import Path
+
+import click
+
+GALLERY_DIR = Path(__file__).parent
+
+
+@click.command(hidden=True)
+def gallery():
+    """Open the gallery to visually verify all supported plots."""
+    script = GALLERY_DIR / "gallery_marimo.py"
+    result = subprocess.run(["marimo", "edit", str(script)], check=False)
+    sys.exit(result.returncode)

pfund_plot/cli/commands/gallery/gallery_marimo.py

@@ -0,0 +1,462 @@
+# ruff: noqa
+
+import marimo
+
+__generated_with = "0.23.4"
+app = marimo.App(width="columns")
+
+with app.setup:
+    from threading import Thread
+
+    import altair as alt
+    import holoviews as hv
+    import marimo as mo
+    import matplotlib.pyplot as mpl
+    import numpy as np
+    import pfeed as pe
+    import plotly.graph_objects as go
+    import polars as pl
+    from bokeh.plotting import figure
+
+    import pfund_plot as plt
+
+    def stop_later(thread, delay):
+        import time
+
+        time.sleep(delay)
+        thread.stop()
+        print("Stopped the streaming thread")
+
+    def prepare_streaming_feed():
+        # separate this streaming feed from the non-streaming one on purpose
+        streaming_feed = pe.Bybit(pipeline_mode=True).market_feed
+        streaming_resolution = "1s"
+        for streaming_product in products:
+            streaming_feed.stream(
+                product=streaming_product,
+                resolution=streaming_resolution,
+            )
+        return streaming_feed
+
+    feed = pe.Bybit(pipeline_mode=True).market_feed
+    products = ["ETH_USDT_PERP", "BTC_USDT_PERP"]
+    date = "2026-03-01"
+    resolution = "1h"
+    storage = "local"
+
+    # FIXME: use pfund-sampledata when its ready
+    for product in products:
+        for func in [feed.retrieve, feed.download]:
+            df = func(
+                product=product,
+                resolution=resolution,
+                start_date=date,
+                end_date=date,
+                storage_config=pe.StorageConfig(
+                    storage=storage,
+                ),
+            ).run()
+            if df is not None:
+                break
+
+    # create some fake columns for plt.marker and plt.label
+    df = df.collect()
+    df = df.with_columns(
+        pl.Series("trade", np.random.choice([1, -1], size=len(df))),
+    ).with_columns(
+        pl.when(pl.col("trade") == 1)
+        .then(pl.lit("buy"))
+        .otherwise(pl.lit("sell"))
+        .alias("label")
+    )
+
+
+@app.cell
+def _():
+    mo.md("""
+    # Gallery
+    This is a gallery of plots supported by `pfund-plot` for maintainers to quickly visualize them to make sure they are working correctly. Press `Cmd + .` to toggle the app view to see all the plots nicely.
+    > WARNING: somehow some widgets don't work in app view or even after switching back from the app view. So you might want to manually test the widgets a bit before toggling it.
+    """)
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Data Used in the Gallery
+    """)
+    return
+
+
+@app.cell
+def _():
+    df.head()
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 1. Candlestick
+    """)
+    return
+
+
+@app.cell
+def _():
+    candlestick = plt.ohlc(df).backend("bokeh")
+    candlestick
+    return (candlestick,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 2. Line
+    """)
+    return
+
+
+@app.cell
+def _():
+    line = (
+        plt.line(df, x="date", y="close").style(color="orange").control(widgets=False)
+    )
+    line
+    return (line,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 3. Scatter
+    """)
+    return
+
+
+@app.cell
+def _():
+    scatter = plt.scatter(df, x="open", y="close").control(widgets=False)
+    scatter
+    return (scatter,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 4. Marker
+    """)
+    return
+
+
+@app.cell
+def _():
+    marker = plt.marker(df, x="date", y="close", signal="trade")
+    marker
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 5. Label
+    """)
+    return
+
+
+@app.cell
+def _():
+    label = plt.label(df, x="date", y="close", text="label")
+    label
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 6. Area
+    """)
+    return
+
+
+@app.cell
+def _():
+    area = plt.area(df, x="date", y="close").style(marker="x")
+    area
+    return (area,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # 7. Bar
+    """)
+    return
+
+
+@app.cell
+def _():
+    bar = plt.bar(df, x="date", y=["high", "low"]).style(color=["steelblue", "coral"])
+    bar
+    return (bar,)
+
+
+@app.cell(column=1, hide_code=True)
+def _():
+    mo.md(r"""
+    # Operators: "+" and "|"
+    """)
+    return
+
+
+@app.cell
+def _(candlestick, line, scatter):
+    (candlestick + line) | scatter
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Overlays: "*"
+    """)
+    return
+
+
+@app.cell
+def _():
+    plt.ohlc(df).backend("bokeh") * plt.label(
+        df, x="date", y="close", text="label"
+    ) * plt.marker(df, x="date", y="close", signal="trade")
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Plotly Wrapper: `plt.plotly`
+    """)
+    return
+
+
+@app.cell
+def _():
+    plotly_fig = go.Figure()
+    plotly_fig.add_trace(go.Scatter(x=df["date"], y=df["close"], mode="lines"))
+    plotly_fig.update_layout(title="Price", xaxis_title="date", yaxis_title="close")
+    plotly_fig = plt.plotly(plotly_fig, sizing_mode="stretch_width")
+    plotly_fig
+    return (plotly_fig,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Altair Wrapper: `plt.altair`
+    """)
+    return
+
+
+@app.cell
+def _():
+    altair_fig = plt.altair(
+        alt.Chart(df)
+        .mark_line()
+        .encode(
+            x="date:T",
+            y=alt.Y("close:Q").scale(zero=False),
+            tooltip=["date:T", "close:Q"],
+        )
+        .properties(
+            title="Price",
+            width=600,
+            height=400,
+        ),
+        sizing_mode="stretch_width",
+    )
+    altair_fig
+    return (altair_fig,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Matplotlib Wrapper: `plt.matplotlib`
+    """)
+    return
+
+
+@app.cell
+def _():
+    matplotlib_fig, ax = mpl.subplots()
+    ax.plot(df["date"], df["close"])
+    ax.set_title("Price")
+    ax.set_xlabel("date")
+    ax.set_ylabel("close")
+    matplotlib_fig = plt.matplotlib(
+        matplotlib_fig, height=500, sizing_mode="stretch_width"
+    )
+    matplotlib_fig
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Bokeh Wrapper: `plt.bokeh`
+    """)
+    return
+
+
+@app.cell
+def _():
+    bokeh_fig = figure(
+        title="Price",
+        x_axis_label="date",
+        y_axis_label="close",
+        x_axis_type="datetime",
+        height=400,
+        width=700,
+    )
+    bokeh_fig.line(df["date"], df["close"])
+    bokeh_fig = plt.bokeh(bokeh_fig, sizing_mode="stretch_width")
+    bokeh_fig
+    return
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Holoviews Wrapper: `plt.holoviews`
+    """)
+    return
+
+
+@app.cell
+def _():
+    holoviews_fig = hv.Curve(df, kdims="date", vdims="close").opts(title="Price")
+    holoviews_fig = plt.holoviews(holoviews_fig, sizing_mode="stretch_width")
+    holoviews_fig
+    return
+
+
+@app.cell(column=2, hide_code=True)
+def _():
+    mo.md(r"""
+    # Reactive Widgets
+    """)
+    return
+
+
+@app.cell
+def _():
+    def get_df(product, resolution):
+        return feed.retrieve(
+            product=product,
+            resolution=resolution,
+            start_date=date,
+            end_date=date,
+            storage_config=pe.StorageConfig(
+                storage=storage,
+            ),
+        ).run()
+
+    reactive_candlestick = plt.ohlc(
+        get_df(products[0], resolution),
+        callback=get_df,
+        product=products,
+        resolution=[resolution],
+    )
+    reactive_candlestick
+    return (reactive_candlestick,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Tabs
+    """)
+    return
+
+
+@app.cell
+def _(altair_fig, area, bar, line, plotly_fig, reactive_candlestick):
+    tabs = plt.tabs(
+        reactive_candlestick,
+        line,
+        area,
+        bar,
+        plotly_fig,
+        altair_fig,
+    )
+    tabs
+    return (tabs,)
+
+
+@app.cell(hide_code=True)
+def _():
+    mo.md(r"""
+    # Layout + Streaming
+    > put streaming plot inside layout so that we can stop them both at the same time
+    """)
+    return
+
+
+@app.cell
+def _(altair_fig, plotly_fig, tabs):
+    browser_thread = (
+        plt.layout(
+            plt.ohlc(prepare_streaming_feed())
+            .control(update_interval=1000)
+            .mode("browser"),
+            tabs,
+            plt.line(prepare_streaming_feed(), x="date", y="close")
+            .control(update_interval=1000)
+            .mode("browser"),
+            plt.area(prepare_streaming_feed(), x="date", y="close")
+            .style(marker="x")
+            .control(update_interval=1000)
+            .mode("browser"),
+            plt.bar(prepare_streaming_feed(), x="date", y="close")
+            .control(update_interval=1000)
+            .mode("browser"),
+            plotly_fig,
+            altair_fig,
+        )
+        .mode("browser")
+        .control(allow_drag=False, linked_axes=False)
+        .show()
+    )
+
+    # stop in background without blocking
+    Thread(target=stop_later, args=(browser_thread, 20)).start()
+    return
+
+
+@app.cell
+def _():
+    desktop_thread = (
+        plt.line(df, x="date", y="close")
+        .style(color="orange")
+        .control(widgets=False)
+        .mode("desktop")
+        .show()
+    )
+    # desktop_thread = plt.layout(
+    #     plt.ohlc(prepare_streaming_feed()).control(update_interval=1000).mode('desktop'),
+    #     tabs,
+    #     plt.line(prepare_streaming_feed(), x='date', y='close').control(update_interval=1000).mode('desktop'),
+    #     plt.area(prepare_streaming_feed(), x='date', y='close').style(marker='x').control(update_interval=1000).mode('desktop'),
+    #     plt.bar(prepare_streaming_feed(), x='date', y='close').control(update_interval=1000).mode('desktop'),
+    #     plotly_fig,
+    #     altair_fig,
+    # ).mode('desktop').control(allow_drag=False, linked_axes=False).show()
+
+    # stop in background without blocking
+    Thread(target=stop_later, args=(desktop_thread, 3)).start()
+    return
+
+
+if __name__ == "__main__":
+    app.run()

pfund_plot/cli/commands/serve.py

@@ -0,0 +1,21 @@
+import subprocess
+import sys
+
+import click
+
+
+@click.command(
+    add_help_option=False,
+    context_settings=dict(
+        ignore_unknown_options=True,
+        allow_extra_args=True,
+    ),
+)
+@click.pass_context
+def serve(ctx):
+    """Serve a Panel application.
+
+    Passes all arguments directly to 'panel serve'.
+    """
+    result = subprocess.run(["panel", "serve", *ctx.args], check=False)
+    sys.exit(result.returncode)

pfund_plot/cli/main.py

@@ -0,0 +1,20 @@
+from pfund_kit.cli import create_cli_group
+from pfund_kit.cli.commands import config, docker_compose, remove
+
+from pfund_plot.cli.commands.gallery import gallery
+from pfund_plot.cli.commands.serve import serve
+
+
+def init_context(ctx):
+    """Initialize pfund_plot-specific context"""
+    from pfund_plot.config import get_config
+
+    ctx.obj["config"] = get_config()
+
+
+pfund_plot_group = create_cli_group("pfund_plot", init_context=init_context)
+pfund_plot_group.add_command(config)
+pfund_plot_group.add_command(docker_compose)
+pfund_plot_group.add_command(remove)
+pfund_plot_group.add_command(serve)
+pfund_plot_group.add_command(gallery)