pfund-plot 0.0.1.dev1__tar.gz → 0.0.1.dev3__tar.gz

pfund_plot-0.0.1.dev3/PKG-INFO

@@ -0,0 +1,101 @@
+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)
+```
+

pfund_plot-0.0.1.dev3/README.md

@@ -0,0 +1,54 @@
+# 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)
+```

pfund_plot-0.0.1.dev3/pfund_plot/__init__.py

@@ -0,0 +1,35 @@
+from importlib.metadata import version
+
+import hvplot
+import panel as pn
+
+from pfund_plot.config_handler import get_config, configure
+from pfund_plot.plots.dataframe import (
+    dataframe_plot as dataframe,
+    dataframe_plot as df,
+)
+from pfund_plot.plots.candlestick import (
+    candlestick_plot as candlestick,
+    candlestick_plot as ohlc,
+    candlestick_plot as kline,
+)
+
+
+hvplot.extension('bokeh', 'plotly')
+pn.extension('tabulator', 'perspective')
+# used to throttle updates in panel plots
+# NOTE: without it, e.g. dragging a slider will cause the plot to update rapidly and lead to an error
+pn.config.throttled = True
+
+
+__version__ = version("pfund_plot")
+__all__ = (
+    "__version__",
+    "get_config",
+    "configure",
+    "candlestick",
+    "ohlc",
+    "kline",
+    "dataframe",
+    "df",
+)

pfund_plot-0.0.1.dev3/pfund_plot/cli/__init__.py

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

pfund_plot-0.0.1.dev3/pfund_plot/cli/commands/config.py

@@ -0,0 +1,81 @@
+import click
+
+from pfeed.const.enums import DataTool
+from pfund_plot.const.paths import PROJ_NAME
+
+
+@click.group()
+def config():
+    """Manage configuration settings."""
+    pass
+
+
+@config.command()
+@click.pass_context
+def list(ctx):
+    """List all available options."""
+    from pprint import pformat
+    from dataclasses import asdict
+    config_dict = asdict(ctx.obj['config'])
+    content = click.style(pformat(config_dict), fg='green')
+    click.echo(f"{PROJ_NAME} config:\n{content}")
+
+
+@config.command()
+@click.pass_context
+def reset(ctx):
+    """Reset the configuration to defaults."""
+    ctx.obj['config'].reset()
+    click.echo(f"{PROJ_NAME} config reset successfully.")
+
+
+@config.command()
+@click.option('--data-tool', '--dt', type=click.Choice(DataTool, case_sensitive=False), help='Set the data tool')
+@click.option('--max-points', '--mp', type=int, help='Set the maximum number of points to display in the plot')
+@click.option('--data-path', '--dp', type=click.Path(resolve_path=True), help='Set the data path')
+@click.option('--cache-path', '--cp', type=click.Path(resolve_path=True), help='Set the cache path')
+def set(**kwargs):
+    """Configures pfund_plot settings."""
+    from pfund_plot.config_handler import configure
+    provided_options = {k: v for k, v in kwargs.items() if v is not None}
+    if not provided_options:
+        raise click.UsageError(f"No options provided. Please run '{PROJ_NAME} config set --help' to see all available options.")
+    else:
+        configure(write=True, **kwargs)
+        click.echo(f"{PROJ_NAME} config updated successfully.")
+
+
+@config.command()
+@click.option('--config-file', '-c', is_flag=True, help=f'Open the {PROJ_NAME}_config.yml file')
+@click.option('--default-editor', '-E', is_flag=True, help='Use default editor')
+def open(config_file, default_editor):
+    """Opens config files, e.g. pfund_plot_config.yml."""
+    from pfund_plot.const.paths import CONFIG_FILE_PATH
+    
+    if sum([config_file]) > 1:
+        click.echo('Please specify only one file to open')
+        return
+    else:
+        if config_file:
+            file_path = CONFIG_FILE_PATH
+        else:
+            click.echo(f'Please specify a file to open, run "{PROJ_NAME} config open --help" for more info')
+            return
+    
+    if default_editor:
+        click.edit(filename=file_path)
+    else:
+        open_with_vscode(file_path)
+        
+        
+def open_with_vscode(file_path):
+    import subprocess
+    try:
+        subprocess.run(["code", str(file_path)], check=True)
+        click.echo(f"Opened {file_path} with VS Code")
+    except subprocess.CalledProcessError:
+        click.echo("Failed to open with VS Code. Falling back to default editor.")
+        click.edit(filename=file_path)
+    except FileNotFoundError:
+        click.echo("VS Code command 'code' not found. Falling back to default editor.")
+        click.edit(filename=file_path)

pfund_plot-0.0.1.dev3/pfund_plot/cli/commands/plot.py

@@ -0,0 +1,7 @@
+import click
+
+
+@click.command()
+def plot():
+    # TODO: add plot function
+    print('plotting!!!')

pfund_plot-0.0.1.dev3/pfund_plot/cli/main.py

@@ -0,0 +1,20 @@
+import click
+from trogon import tui
+
+from pfund_plot.config_handler import get_config
+from pfund_plot.cli.commands.plot import plot
+from pfund_plot.cli.commands.config import config
+
+
+@tui(command='tui', help="Open terminal UI")
+@click.group(context_settings={"help_option_names": ["-h", "--help"]})
+@click.pass_context
+@click.version_option()
+def pfund_plot_group(ctx):
+    """PFundPlot's CLI"""
+    ctx.ensure_object(dict)
+    ctx.obj['config'] = get_config(verbose=False)
+
+
+pfund_plot_group.add_command(plot)
+pfund_plot_group.add_command(config)

pfund_plot-0.0.1.dev3/pfund_plot/composites/composite.py

@@ -0,0 +1,13 @@
+# TEMP
+# composites are plots combined together on the same canvas
+# it can be used to perform comparison analysis, create a graph that has the price line, equity curve etc. 
+
+# use plotly for composite plots
+class CompositePlot:
+    def __init__(self, plots):
+        self.plots = plots
+
+    def render(self):
+        # Implement logic to combine plots
+        # This is non-trivial and may require standardizing on a single backend
+        pass

pfund_plot-0.0.1.dev3/pfund_plot/config_handler.py

@@ -0,0 +1,136 @@
+import os
+import shutil
+from dataclasses import dataclass, asdict
+
+import yaml
+
+from pfund_plot.const.paths import (
+    PROJ_NAME, 
+    DATA_PATH,
+    CACHE_PATH,
+    CONFIG_PATH, 
+    CONFIG_FILE_PATH
+)
+
+
+__all__ = [
+    'get_config',
+    'configure',
+]
+
+
+@dataclass
+class ConfigHandler:
+    data_path: str = str(DATA_PATH)
+    cache_path: str = str(CACHE_PATH)
+    
+    _instance = None
+    _verbose = False
+
+    @classmethod
+    def get_instance(cls):
+        if cls._instance is None:
+            cls._instance = cls.load()
+        return cls._instance
+
+    @classmethod
+    def set_verbose(cls, verbose: bool):
+        cls._verbose = verbose
+    
+    @classmethod
+    def load(cls):
+        '''Loads user's config file and returns a ConfigHandler object'''
+        CONFIG_FILE_PATH.parent.mkdir(parents=True, exist_ok=True)
+        # Create default config from dataclass fields
+        default_config = {
+            field.name: field.default 
+            for field in cls.__dataclass_fields__.values()
+            if not field.name.startswith('_')  # Skip private fields
+        }
+        needs_update = False
+        if CONFIG_FILE_PATH.is_file():
+            with open(CONFIG_FILE_PATH, 'r') as f:
+                saved_config = yaml.safe_load(f) or {}
+                if cls._verbose:
+                    print(f"{PROJ_NAME} config loaded from {CONFIG_FILE_PATH}.")
+                # Check for new or removed fields
+                new_fields = set(default_config.keys()) - set(saved_config.keys())
+                removed_fields = set(saved_config.keys()) - set(default_config.keys())
+                needs_update = bool(new_fields or removed_fields)
+                
+                if cls._verbose and needs_update:
+                    if new_fields:
+                        print(f"New config fields detected: {new_fields}")
+                    if removed_fields:
+                        print(f"Removed config fields detected: {removed_fields}")
+                        
+                # Filter out removed fields and merge with defaults
+                saved_config = {k: v for k, v in saved_config.items() if k in default_config}
+                config = {**default_config, **saved_config}
+        else:
+            config = default_config
+            needs_update = True
+        config_handler = cls(**config)
+        if needs_update:
+            config_handler.dump()
+        return config_handler
+    
+    @classmethod
+    def reset(cls):
+        '''Resets the config by deleting the user config directory and reloading the config'''
+        shutil.rmtree(CONFIG_PATH)
+        if cls._verbose:
+            print(f"{PROJ_NAME} config successfully reset.")
+        return cls.load()
+    
+    def dump(self):
+        with open(CONFIG_FILE_PATH, 'w') as f:
+            yaml.dump(asdict(self), f, default_flow_style=False)
+            if self._verbose:
+                print(f"{PROJ_NAME} config saved to {CONFIG_FILE_PATH}.")
+    
+    def __post_init__(self):
+        self._initialize_configs()
+    
+    def _initialize_configs(self):
+        for path in [self.data_path, self.cache_path]:
+            if not os.path.exists(path):
+                os.makedirs(path)
+                if self._verbose:
+                    print(f'{PROJ_NAME} created {path}')
+                
+
+def configure(
+    data_path: str | None = None,
+    cache_path: str | None = None,
+    verbose: bool = False,
+    write: bool = False,
+):
+    '''Configures the global config object.
+    It will override the existing config values from the existing config file or the default values.
+    Args:
+        write: If True, the config will be saved to the config file.
+    '''
+    NON_CONFIG_KEYS = ['verbose', 'write']
+    config_updates = locals()
+    for k in NON_CONFIG_KEYS:
+        config_updates.pop(k)
+    config_updates.pop('NON_CONFIG_KEYS')
+
+    config = get_config(verbose=verbose)
+
+    # Apply updates for non-None values
+    for k, v in config_updates.items():
+        if v is not None:
+            setattr(config, k, v)
+            
+    if write:
+        config.dump()
+        
+    config._initialize_configs()
+    return config
+
+
+def get_config(verbose: bool = False) -> ConfigHandler:
+    ConfigHandler.set_verbose(verbose)
+    return ConfigHandler.get_instance()

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/__init__.py

@@ -0,0 +1,6 @@
+from pfund_plot.const.enums.notebook_type import NotebookType
+from pfund_plot.const.enums.dashboard_type import DashboardType
+from pfund_plot.const.enums.plotting_backend import PlottingBackend
+from pfund_plot.const.enums.display_mode import DisplayMode
+from pfund_plot.const.enums.data_type import DataType
+from pfund_plot.const.enums.dataframe_backend import DataFrameBackend

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/dashboard_type.py

@@ -0,0 +1,8 @@
+from enum import StrEnum
+
+
+class DashboardType(StrEnum):
+    DASH = 'DASH'
+    STREAMLIT = 'STREAMLIT'
+    GRADIO = 'GRADIO'
+    TAIPY = 'TAIPY'

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/data_type.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class DataType(StrEnum):
+    dataframe = 'dataframe'
+    datafeed = 'datafeed'  # pfeed's feed object

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/dataframe_backend.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class DataFrameBackend(StrEnum):
+    tabulator = 'tabulator'
+    perspective = 'perspective'

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/display_mode.py

@@ -0,0 +1,7 @@
+from enum import StrEnum
+
+
+class DisplayMode(StrEnum):
+    notebook = "notebook"
+    browser = "browser"
+    desktop = "desktop"

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/notebook_type.py

@@ -0,0 +1,7 @@
+from enum import StrEnum
+
+
+class NotebookType(StrEnum):
+    jupyter = 'jupyter'
+    marimo = 'marimo'
+    vscode = 'vscode'

pfund_plot-0.0.1.dev3/pfund_plot/const/enums/plotting_backend.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class PlottingBackend(StrEnum):
+    bokeh = 'bokeh'
+    plotly = 'plotly'

pfund_plot-0.0.1.dev3/pfund_plot/const/paths.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+from platformdirs import user_data_dir, user_config_dir, user_cache_dir
+
+
+# project paths
+PROJ_NAME = Path(__file__).resolve().parents[1].name
+MAIN_PATH = Path(__file__).resolve().parents[2]
+PROJ_PATH = MAIN_PATH / PROJ_NAME
+
+
+# user paths
+DATA_PATH = Path(user_data_dir()) / PROJ_NAME
+CACHE_PATH = Path(user_cache_dir()) / PROJ_NAME
+CONFIG_PATH = Path(user_config_dir()) / PROJ_NAME / 'config'
+CONFIG_FILE_PATH = CONFIG_PATH / f'{PROJ_NAME}_config.yml'

pfund_plot-0.0.1.dev3/pfund_plot/main.py

@@ -0,0 +1,18 @@
+import atexit
+
+from pfund_plot.cli import pfund_plot_group
+
+
+def exit_cli():
+    """Application Exitpoint."""
+    print("Cleanup actions here...")
+
+
+def run_cli() -> None:
+    """Application Entrypoint."""
+    # atexit.register(exit_cli)
+    pfund_plot_group(obj={})
+
+
+if __name__ == '__main__':
+    run_cli()