pfund-plot


Namepfund-plot JSON
Version 0.0.1.dev3 PyPI version JSON
download
home_pagehttps://pfund.ai
SummaryA library for financial data visualization, dashboard creation, and template sharing.
upload_time2024-12-31 09:06:54
maintainerNone
docs_urlNone
authorstephenyau
requires_python<4.0,>=3.10
licenseApache-2.0
keywords financial data plotting dashboards charts data visualization graphs plots
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://pfund.ai",
    "name": "pfund-plot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "financial data, plotting, dashboards, charts, data visualization, graphs, plots",
    "author": "stephenyau",
    "author_email": "softwareentrepreneer+pfund-plot@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/64/07/9b513ec2d15a553f5e1fa7cbdd8c3ab6165bc48554d7239a9a9a3cde2426/pfund_plot-0.0.1.dev3.tar.gz",
    "platform": null,
    "description": "# PFund-Plot\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/pfund_ai?style=social)](https://x.com/pfund_ai)\n![GitHub stars](https://img.shields.io/github/stars/PFund-Software-Ltd/pfund-plot?style=social)\n[![Jupyter Notebook](https://img.shields.io/badge/jupyter-notebook-orange?logo=jupyter)](https://jupyter.org)\n[![Marimo](https://marimo.io/shield.svg)](https://marimo.io)\n![PyPI downloads](https://img.shields.io/pypi/dm/pfund-plot?label=downloads)\n[![PyPI](https://img.shields.io/pypi/v/pfund-plot.svg)](https://pypi.org/project/pfund-plot)\n![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/pfund-plot)\n\n## Problem\nTraders often need to quickly visualize their data without investing time in learning new tools.\nFor example, plotting an orderbook should be as simple as writing a single line of code.\n\n## Solution\nWe created a high-level plotting library that combines the best features from existing plotting and dashboarding libraries into an easy-to-use interface.\n\n---\n<img src=\"docs/assets/candlestick.gif\" alt=\"pfund-plot candlestick streaming example\" width=\"450\">\n\n<!-- <div style=\"display: flex; justify-content: space-around; align-items: center;\">\n    <img src=\"docs/assets/candlestick.gif\" alt=\"pfund-plot streaming example\" width=\"450\">\n    <img src=\"docs/assets/orderbook.gif\" alt=\"pfund-plot streaming example\" width=\"450\">\n</div> -->\n\n---\n\nPFund-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**.\n\n> This library is not ready, please wait for version 0.0.1 release.\n\n## Core Features\n- [x] Multi-Display Mode: support displaying plots in a *Jupyter notebook*, *Marimo notebook*, *browser* and *desktop window*\n- [x] Streaming Data: support streaming data in real-time by just setting `streaming=True`\n- [x] DataFrame Agnostic: support pandas, polars, and dask\n- [x] Big Data Plotting: support plotting large datasets\n- [x] Financial Plots: plot financial data by just one function call, e.g. candlestick, orderbook, trades etc.\n- [x] Combine multiple plots into a dashboard quickly for visualization\n\n\n## Installation\n```bash\npip install pfund-plot\n```\n\n\n## Usage\n```python\nimport pfund_plot as plt\n\n# TODO: get some sample data using pfeed\ndata = ...\nfig = plt.ohlc(data)\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A library for financial data visualization, dashboard creation, and template sharing.",
    "version": "0.0.1.dev3",
    "project_urls": {
        "Documentation": "https://pfund-plot-docs.pfund.ai",
        "Homepage": "https://pfund.ai",
        "Repository": "https://github.com/PFund-Software-Ltd/pfund-plot"
    },
    "split_keywords": [
        "financial data",
        " plotting",
        " dashboards",
        " charts",
        " data visualization",
        " graphs",
        " plots"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a6d25bdb42c3ad9a74d3a50da7c97eb439ba2afe1a0b54f0b03cd8f85f1e7ecf",
                "md5": "7f3cedcd5a29e0d5d1b2ed62088d20d1",
                "sha256": "83adf357814746c2e4d665c48f167929c51d08add509b3856e6c5c40f27dd23b"
            },
            "downloads": -1,
            "filename": "pfund_plot-0.0.1.dev3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7f3cedcd5a29e0d5d1b2ed62088d20d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 28070,
            "upload_time": "2024-12-31T09:06:51",
            "upload_time_iso_8601": "2024-12-31T09:06:51.505732Z",
            "url": "https://files.pythonhosted.org/packages/a6/d2/5bdb42c3ad9a74d3a50da7c97eb439ba2afe1a0b54f0b03cd8f85f1e7ecf/pfund_plot-0.0.1.dev3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "64079b513ec2d15a553f5e1fa7cbdd8c3ab6165bc48554d7239a9a9a3cde2426",
                "md5": "ecbf5fa418d034f40a035eda6b1d24bf",
                "sha256": "3defb2b6f6ca0700e9b5c81ca8ceacc735f28cf3df64a8bfa853afac5afbd199"
            },
            "downloads": -1,
            "filename": "pfund_plot-0.0.1.dev3.tar.gz",
            "has_sig": false,
            "md5_digest": "ecbf5fa418d034f40a035eda6b1d24bf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 38260,
            "upload_time": "2024-12-31T09:06:54",
            "upload_time_iso_8601": "2024-12-31T09:06:54.106945Z",
            "url": "https://files.pythonhosted.org/packages/64/07/9b513ec2d15a553f5e1fa7cbdd8c3ab6165bc48554d7239a9a9a3cde2426/pfund_plot-0.0.1.dev3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-31 09:06:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PFund-Software-Ltd",
    "github_project": "pfund-plot",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pfund-plot"
}
        
Elapsed time: 0.76722s