pfund-plot 0.0.1.dev3__tar.gz → 0.0.3__tar.gz

pfund_plot-0.0.3/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: pfund-plot
+Version: 0.0.3
+Summary: A library for financial data visualization
+Keywords: financial data,plotting,dashboards,charts,data visualization,graphs,plots
+Author: Stephen Yau
+Author-email: Stephen Yau <softwareentrepreneer+pfund-plot@gmail.com>
+License-Expression: Apache-2.0
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pfeed>=0.0.15
+Requires-Dist: panel>=1.9.3
+Requires-Dist: hvplot>=0.12.2
+Requires-Dist: dayplot>=0.5.1
+Requires-Dist: anywidget>=0.11.0 ; sys_platform != 'emscripten'
+Requires-Dist: ipywidgets-bokeh>=1.7.0 ; sys_platform != 'emscripten'
+Requires-Dist: pywebview>=6.2.1 ; sys_platform != 'emscripten'
+Requires-Dist: datashader>=0.19.1 ; sys_platform != 'emscripten'
+Requires-Dist: altair>=6.1.0 ; extra == 'altair'
+Requires-Dist: vegafusion>=2.0.3 ; extra == 'altair'
+Requires-Dist: vl-convert-python>=1.9.0.post1 ; extra == 'altair'
+Requires-Dist: jupyter-bokeh>=4.0.5 ; extra == 'jupyter'
+Requires-Dist: notebook>=7.5.7 ; extra == 'jupyter'
+Requires-Dist: papermill>=2.7.0 ; extra == 'jupyter'
+Requires-Dist: voila>=0.5.12 ; extra == 'jupyter'
+Requires-Dist: marimo[recommended,lsp]>=0.23.9 ; extra == 'marimo'
+Requires-Dist: matplotlib>=3.10.9 ; extra == 'matplotlib'
+Requires-Dist: plotly>=6.8.0 ; extra == 'plotly'
+Requires-Python: >=3.11
+Project-URL: homepage, https://pfund-plot.pfund.ai
+Project-URL: repository, https://github.com/PFund-Software-Ltd/pfund-plot
+Project-URL: documentation, https://pfund-plot.pfund.ai/doc
+Provides-Extra: altair
+Provides-Extra: jupyter
+Provides-Extra: marimo
+Provides-Extra: matplotlib
+Provides-Extra: plotly
+Description-Content-Type: text/markdown
+
+# `pfund-plot`: Financial Charts in One Line of Code
+
+[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/vqpS94tpdp)
+[![X](https://img.shields.io/twitter/follow/pfund_ai?style=social)](https://x.com/pfund_ai)
+[![Downloads](https://static.pepy.tech/badge/pfund-plot/month)](https://pepy.tech/project/pfund-plot)
+[![PyPI](https://img.shields.io/pypi/v/pfund-plot.svg?cacheSeconds=300)](https://pypi.org/project/pfund-plot)
+![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/pfund-plot?cacheSeconds=300)
+[![afterpython](https://afterpython.org/shield.svg)](https://afterpython.org)
+[![Discussions](https://img.shields.io/badge/Discussions-Let's%20Chat-green)](https://github.com/PFund-Software-Ltd/pfund-plot/discussions)
+[![Jupyter Notebook](https://img.shields.io/badge/jupyter-notebook-orange?logo=jupyter)](https://jupyter.org)
+[![Marimo](https://marimo.io/shield.svg)](https://marimo.io)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/PFund-Software-Ltd/pfund-plot)
+[![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/pfund-software-ltd/pfund-plot?utm_source=badge&utm_medium=github&utm_campaign=github.com/pfund-software-ltd/pfund-plot)
+<!-- ![PyPI downloads](https://img.shields.io/pypi/dm/pfund-plot?label=downloads&cacheSeconds=86400) -->
+<!-- ![GitHub stars](https://img.shields.io/github/stars/PFund-Software-Ltd/pfund-plot?style=social) -->
+
+
+## TL;DR: pfund-plot handles the plotting libraries, so traders just get charts that work
+
+## Problem
+Traders often need to quickly visualize their data without investing time in learning new tools.
+For example, plotting a candlestick should be as simple as writing a single line of code.
+
+## Solution
+We created a high-level financial visualization layer that combines the best features from existing plotting libraries into an easy-to-use interface.
+
+---
+<img src="afterpython/static/candlestick.gif" alt="pfund-plot candlestick streaming example" width="450">
+
+---
+
+`pfund-plot` is a financial visualization layer on top of existing plotting libraries, giving traders a simple, domain-specific interface for plotting and streaming market data.
+
+## Core Features
+- [x] Multi-Display Mode: support displaying plots in a *Jupyter notebook*, *Marimo notebook*, *browser* and *desktop window*
+- [x] Intuitive & Chainable API: `plt.ohlc(df).style(...).control(...).mode(...).show()`
+- [x] Streaming Plots: support streaming data in real-time
+- [x] DataFrame Agnostic: support pandas, polars, and dask
+- [x] Financial Plots: plot financial data by just one function call
+- [x] Combine multiple plots into a dashboard quickly for visualization
+
+
+## Installation
+```bash
+pip install pfund-plot
+```
+
+## Quickstart
+### 1. Plotting in a Jupyter or Marimo Notebook
+> To use data sources other than Bybit, please go to [pfeed](https://github.com/PFund-Software-Ltd/pfeed) and install the corresponding extras. For example: `pip install "pfeed[data_source1, data_source2]"`
+```python
+import pfeed as pe
+import pfund_plot as plt
+
+feed = pe.Bybit().market_feed
+result = feed.download(product='BTC_USDT_PERP', resolution='1h', rollback_period='1d')
+df = result.data.collect()
+
+# Notebook mode:
+plt.ohlc(df)
+```
+
+### 2. Plotting in a Python Script
+```python
+# Browser mode:
+plt.ohlc(df).mode('browser').show()
+
+# Desktop mode:
+if __name__ == "__main__":  # Required because desktop mode uses multiprocessing.
+    plt.ohlc(df).mode('desktop').show()
+```
+
+### 3. Streaming a Plot
+```python
+# Streaming requires pipeline_mode=True.
+feed = pe.Bybit(pipeline_mode=True).market_feed
+feed.stream(product='BTC_USDT_PERP', resolution='1s')
+
+# In a Python script:
+plt.ohlc(feed).control(update_interval=1000).mode('browser')  # or mode('desktop') under if __name__ == "__main__"
+
+# In a notebook environment (not recommended to start streaming in a notebook unless you know what you're doing):
+# await plt.ohlc(feed).control(update_interval=1000).show_async()
+```
+
+---
+
+## Tapping into the JavaScript World
+Python developers sometimes envy the JavaScript visualization ecosystem for its rich set of interactive charts and dashboards. With `pfund-plot`, they can still enjoy the benefits of the JavaScript world while keeping the same Python-first API. For example:
+```python
+plt.ohlc(df).backend('svelte')
+```
+This renders the following chart using TradingView's [Lightweight Charts](https://github.com/tradingview/lightweight-charts):
+
+<img src="afterpython/static/tradingview.png" alt="pfund-plot TradingView Lightweight Charts example" width="450">
+
+> This is meant as a showcase rather than a core direction: `pfund-plot` remains Python-first, and JavaScript-backed charts are supported where they fit naturally. If you want to bring more useful JavaScript visualizations into `pfund-plot`, contributions are welcome.

pfund_plot-0.0.3/README.md

@@ -0,0 +1,97 @@
+# `pfund-plot`: Financial Charts in One Line of Code
+
+[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?logo=discord&logoColor=white)](https://discord.gg/vqpS94tpdp)
+[![X](https://img.shields.io/twitter/follow/pfund_ai?style=social)](https://x.com/pfund_ai)
+[![Downloads](https://static.pepy.tech/badge/pfund-plot/month)](https://pepy.tech/project/pfund-plot)
+[![PyPI](https://img.shields.io/pypi/v/pfund-plot.svg?cacheSeconds=300)](https://pypi.org/project/pfund-plot)
+![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/pfund-plot?cacheSeconds=300)
+[![afterpython](https://afterpython.org/shield.svg)](https://afterpython.org)
+[![Discussions](https://img.shields.io/badge/Discussions-Let's%20Chat-green)](https://github.com/PFund-Software-Ltd/pfund-plot/discussions)
+[![Jupyter Notebook](https://img.shields.io/badge/jupyter-notebook-orange?logo=jupyter)](https://jupyter.org)
+[![Marimo](https://marimo.io/shield.svg)](https://marimo.io)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/PFund-Software-Ltd/pfund-plot)
+[![View Code Wiki](https://assets.codewiki.google/readme-badge/static.svg)](https://codewiki.google/github.com/pfund-software-ltd/pfund-plot?utm_source=badge&utm_medium=github&utm_campaign=github.com/pfund-software-ltd/pfund-plot)
+<!-- ![PyPI downloads](https://img.shields.io/pypi/dm/pfund-plot?label=downloads&cacheSeconds=86400) -->
+<!-- ![GitHub stars](https://img.shields.io/github/stars/PFund-Software-Ltd/pfund-plot?style=social) -->
+
+
+## TL;DR: pfund-plot handles the plotting libraries, so traders just get charts that work
+
+## Problem
+Traders often need to quickly visualize their data without investing time in learning new tools.
+For example, plotting a candlestick should be as simple as writing a single line of code.
+
+## Solution
+We created a high-level financial visualization layer that combines the best features from existing plotting libraries into an easy-to-use interface.
+
+---
+<img src="afterpython/static/candlestick.gif" alt="pfund-plot candlestick streaming example" width="450">
+
+---
+
+`pfund-plot` is a financial visualization layer on top of existing plotting libraries, giving traders a simple, domain-specific interface for plotting and streaming market data.
+
+## Core Features
+- [x] Multi-Display Mode: support displaying plots in a *Jupyter notebook*, *Marimo notebook*, *browser* and *desktop window*
+- [x] Intuitive & Chainable API: `plt.ohlc(df).style(...).control(...).mode(...).show()`
+- [x] Streaming Plots: support streaming data in real-time
+- [x] DataFrame Agnostic: support pandas, polars, and dask
+- [x] Financial Plots: plot financial data by just one function call
+- [x] Combine multiple plots into a dashboard quickly for visualization
+
+
+## Installation
+```bash
+pip install pfund-plot
+```
+
+## Quickstart
+### 1. Plotting in a Jupyter or Marimo Notebook
+> To use data sources other than Bybit, please go to [pfeed](https://github.com/PFund-Software-Ltd/pfeed) and install the corresponding extras. For example: `pip install "pfeed[data_source1, data_source2]"`
+```python
+import pfeed as pe
+import pfund_plot as plt
+
+feed = pe.Bybit().market_feed
+result = feed.download(product='BTC_USDT_PERP', resolution='1h', rollback_period='1d')
+df = result.data.collect()
+
+# Notebook mode:
+plt.ohlc(df)
+```
+
+### 2. Plotting in a Python Script
+```python
+# Browser mode:
+plt.ohlc(df).mode('browser').show()
+
+# Desktop mode:
+if __name__ == "__main__":  # Required because desktop mode uses multiprocessing.
+    plt.ohlc(df).mode('desktop').show()
+```
+
+### 3. Streaming a Plot
+```python
+# Streaming requires pipeline_mode=True.
+feed = pe.Bybit(pipeline_mode=True).market_feed
+feed.stream(product='BTC_USDT_PERP', resolution='1s')
+
+# In a Python script:
+plt.ohlc(feed).control(update_interval=1000).mode('browser')  # or mode('desktop') under if __name__ == "__main__"
+
+# In a notebook environment (not recommended to start streaming in a notebook unless you know what you're doing):
+# await plt.ohlc(feed).control(update_interval=1000).show_async()
+```
+
+---
+
+## Tapping into the JavaScript World
+Python developers sometimes envy the JavaScript visualization ecosystem for its rich set of interactive charts and dashboards. With `pfund-plot`, they can still enjoy the benefits of the JavaScript world while keeping the same Python-first API. For example:
+```python
+plt.ohlc(df).backend('svelte')
+```
+This renders the following chart using TradingView's [Lightweight Charts](https://github.com/tradingview/lightweight-charts):
+
+<img src="afterpython/static/tradingview.png" alt="pfund-plot TradingView Lightweight Charts example" width="450">
+
+> This is meant as a showcase rather than a core direction: `pfund-plot` remains Python-first, and JavaScript-backed charts are supported where they fit naturally. If you want to bring more useful JavaScript visualizations into `pfund-plot`, contributions are welcome.

pfund_plot-0.0.3/pyproject.toml

@@ -0,0 +1,85 @@
+[project]
+name = "pfund-plot"
+version = "0.0.3"
+description = "A library for financial data visualization"
+license = "Apache-2.0"
+authors = [
+    {name = "Stephen Yau", email = "softwareentrepreneer+pfund-plot@gmail.com"}
+]
+readme = "README.md"
+keywords = ["financial data", "plotting", "dashboards", "charts", "data visualization", "graphs", "plots"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Intended Audience :: Information Technology",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Scientific/Engineering :: Visualization",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "pfeed>=0.0.15",
+    "panel>=1.9.3",
+    "hvplot>=0.12.2",
+    "dayplot>=0.5.1",
+    "anywidget>=0.11.0 ; sys_platform != 'emscripten'",
+    "ipywidgets-bokeh>=1.7.0 ; sys_platform != 'emscripten'",
+    "pywebview>=6.2.1 ; sys_platform != 'emscripten'",
+    "datashader>=0.19.1 ; sys_platform != 'emscripten'",
+]
+
+[project.optional-dependencies]
+marimo = ["marimo[recommended,lsp]>=0.23.9"]
+jupyter = [
+    "jupyter-bokeh>=4.0.5",
+    "notebook>=7.5.7",
+    "papermill>=2.7.0",
+    "voila>=0.5.12",
+]
+matplotlib = ["matplotlib>=3.10.9"]
+plotly = ["plotly>=6.8.0"]
+altair = [
+    "altair>=6.1.0",
+    "vegafusion>=2.0.3",
+    "vl-convert-python>=1.9.0.post1",
+]
+
+[project.scripts]
+plt = "pfund_plot.__main__:run_cli"
+
+[project.entry-points."pfund_shell.commands"]
+plt = "pfund_plot.cli:pfund_plot_group"
+
+[project.urls]
+homepage = "https://pfund-plot.pfund.ai"
+repository = "https://github.com/PFund-Software-Ltd/pfund-plot"
+documentation = "https://pfund-plot.pfund.ai/doc"
+
+[build-system]
+requires = ["uv_build>=0.11.19,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.pyright]
+# typeCheckingMode = "basic"
+reportAny = false
+reportExplicitAny = false
+reportUnnecessaryIsInstance = false
+reportIncompatibleVariableOverride = false
+reportIncompatibleMethodOverride = false
+reportRedeclaration = false
+reportUnreachable = false
+reportImportCycles = false
+reportPrivateUsage = false
+reportMissingTypeStubs = false
+reportUnannotatedClassAttribute = false
+reportImplicitOverride = false
+
+[tool.uv.build-backend]
+module-name = "pfund_plot"
+module-root = "src"

pfund_plot-0.0.3/src/pfund_plot/__init__.py

@@ -0,0 +1,178 @@
+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.
+)
+
+
+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-0.0.3/src/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-0.0.1.dev3 → pfund_plot-0.0.3/src}/pfund_plot/cli/__init__.py

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

pfund_plot-0.0.3/src/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)