Metadata-Version: 2.1
Name: pfund-plot
Version: 0.0.1.dev3
Summary: A library for financial data visualization, dashboard creation, and template sharing.
Home-page: https://pfund.ai
License: Apache-2.0
Keywords: financial data,plotting,dashboards,charts,data visualization,graphs,plots
Author: stephenyau
Author-email: softwareentrepreneer+pfund-plot@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Libraries
Provides-Extra: all
Provides-Extra: dash
Provides-Extra: gradio
Provides-Extra: solara
Provides-Extra: streamlit
Provides-Extra: taipy
Requires-Dist: dash (>=2.18.1,<3.0.0) ; extra == "dash" or extra == "all"
Requires-Dist: gradio (>=5.9.1,<6.0.0) ; extra == "gradio" or extra == "all"
Requires-Dist: hvplot[datashader,plotly] (>=0.11.2,<0.12.0)
Requires-Dist: jupyter-bokeh (>=4.0.5,<5.0.0)
Requires-Dist: narwhals (>=1.19.1,<2.0.0)
Requires-Dist: panel (>=1.5.5,<2.0.0)
Requires-Dist: papermill (>=2.6.0,<3.0.0)
Requires-Dist: pfeed (>=0.0.2,<0.0.3)
Requires-Dist: pywebview (>=5.3.2,<6.0.0)
Requires-Dist: streamlit (>=1.41.1,<2.0.0) ; extra == "streamlit" or extra == "all"
Requires-Dist: taipy (>=4.0.0,<5.0.0) ; extra == "taipy" or extra == "all"
Requires-Dist: voila (>=0.5.8,<0.6.0)
Project-URL: Documentation, https://pfund-plot-docs.pfund.ai
Project-URL: Repository, https://github.com/PFund-Software-Ltd/pfund-plot
Description-Content-Type: text/markdown

# PFund-Plot

[![Twitter Follow](https://img.shields.io/twitter/follow/pfund_ai?style=social)](https://x.com/pfund_ai)
![GitHub stars](https://img.shields.io/github/stars/PFund-Software-Ltd/pfund-plot?style=social)
[![Jupyter Notebook](https://img.shields.io/badge/jupyter-notebook-orange?logo=jupyter)](https://jupyter.org)
[![Marimo](https://marimo.io/shield.svg)](https://marimo.io)
![PyPI downloads](https://img.shields.io/pypi/dm/pfund-plot?label=downloads)
[![PyPI](https://img.shields.io/pypi/v/pfund-plot.svg)](https://pypi.org/project/pfund-plot)
![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/pfund-plot)

## Problem
Traders often need to quickly visualize their data without investing time in learning new tools.
For example, plotting an orderbook should be as simple as writing a single line of code.

## Solution
We created a high-level plotting library that combines the best features from existing plotting and dashboarding libraries into an easy-to-use interface.

---
<img src="docs/assets/candlestick.gif" alt="pfund-plot candlestick streaming example" width="450">

<!-- <div style="display: flex; justify-content: space-around; align-items: center;">
    <img src="docs/assets/candlestick.gif" alt="pfund-plot streaming example" width="450">
    <img src="docs/assets/orderbook.gif" alt="pfund-plot streaming example" width="450">
</div> -->

---

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**.

> This library is not ready, please wait for version 0.0.1 release.

## Core Features
- [x] Multi-Display Mode: support displaying plots in a *Jupyter notebook*, *Marimo notebook*, *browser* and *desktop window*
- [x] Streaming Data: support streaming data in real-time by just setting `streaming=True`
- [x] DataFrame Agnostic: support pandas, polars, and dask
- [x] Big Data Plotting: support plotting large datasets
- [x] Financial Plots: plot financial data by just one function call, e.g. candlestick, orderbook, trades etc.
- [x] Combine multiple plots into a dashboard quickly for visualization


## Installation
```bash
pip install pfund-plot
```


## Usage
```python
import pfund_plot as plt

# TODO: get some sample data using pfeed
data = ...
fig = plt.ohlc(data)
```

