pfund 0.0.1.dev13__tar.gz → 0.0.2.dev1__tar.gz

{pfund-0.0.1.dev13 → pfund-0.0.2.dev1}/PKG-INFO

@@ -1,54 +1,67 @@
 Metadata-Version: 2.1
 Name: pfund
-Version: 0.0.1.dev13
+Version: 0.0.2.dev1
 Summary: A Complete Algo-Trading Framework for Machine Learning, enabling trading across TradFi, CeFi and DeFi. Supports Vectorized and Event-Driven Backtesting, Paper and Live Trading
 Home-page: https://pfund.ai
 License: Apache-2.0
 Keywords: trading,algo-trading,stocks,cryptos,cryptocurrencies,TradFi,CeFi,DeFi,portfolio management,investment,backtesting,machine learning
 Author: Stephen Yau
 Author-email: softwareentrepreneer+pfund@gmail.com
-Requires-Python: >=3.10,<3.13
+Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Provides-Extra: analytics
+Provides-Extra: all
 Provides-Extra: data
+Provides-Extra: fe
 Provides-Extra: ml
+Provides-Extra: stats
+Provides-Extra: train
 Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: duckdb (>=1.0.0,<2.0.0)
+Requires-Dist: feast (>=0.40.1,<0.41.0) ; extra == "fe" or extra == "all"
 Requires-Dist: gitpython (>=3.1.43,<4.0.0)
-Requires-Dist: mlflow (>=2.11.3,<3.0.0) ; extra == "ml"
-Requires-Dist: orjson (>=3.9.14,<4.0.0) ; extra == "data"
-Requires-Dist: papermill (>=2.5.0,<3.0.0) ; extra == "analytics"
-Requires-Dist: pfeed[boost,data,df] (>=0.0.1.dev11,<0.0.2) ; extra == "data"
-Requires-Dist: pfolio[bayesian,data,portfolio,temporary] (>=0.0.1.dev4,<0.0.2) ; extra == "analytics"
-Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
+Requires-Dist: ipython (>=8.23.0,<9.0.0)
+Requires-Dist: mlflow (>=2.16.1,<3.0.0) ; extra == "ml" or extra == "all"
+Requires-Dist: optuna (>=4.0.0,<5.0.0) ; extra == "train" or extra == "all"
+Requires-Dist: orjson (>=3.10.1,<4.0.0)
+Requires-Dist: papermill (>=2.6.0,<3.0.0) ; extra == "stats" or extra == "all"
+Requires-Dist: pfeed[all] (>=0.0.2.dev1,<0.0.3) ; extra == "data" or extra == "all"
+Requires-Dist: pfolio (>=0.0.1.dev4,<0.0.2) ; extra == "stats" or extra == "train" or extra == "all"
+Requires-Dist: platformdirs (>=4.3.6,<5.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
-Requires-Dist: python-telegram-bot (>=20.7,<21.0)
+Requires-Dist: python-telegram-bot (>=21.5,<22.0)
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
-Requires-Dist: pyzmq (>=25.1.2,<26.0.0) ; extra == "data"
+Requires-Dist: pyzmq (>=26.2.0,<27.0.0) ; extra == "data" or extra == "all"
+Requires-Dist: redis[hiredis] (>=5.1.1,<6.0.0) ; extra == "data" or extra == "all"
 Requires-Dist: requests (>=2.31.0,<3.0.0)
-Requires-Dist: rich (>=13.7.0,<14.0.0)
-Requires-Dist: schedule (>=1.2.1,<2.0.0)
-Requires-Dist: scikit-learn (>=1.4.0,<2.0.0) ; extra == "ml"
-Requires-Dist: ta (>=0.11.0,<0.12.0) ; extra == "ml"
-Requires-Dist: torch (>=2.1.2,<3.0.0) ; extra == "ml"
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Requires-Dist: schedule (>=1.2.2,<2.0.0)
+Requires-Dist: scikit-learn (>=1.5.2,<2.0.0) ; extra == "ml" or extra == "all"
+Requires-Dist: streamlit (>=1.39.0,<2.0.0) ; extra == "train" or extra == "all"
+Requires-Dist: ta (>=0.11.0,<0.12.0) ; extra == "fe" or extra == "all"
+Requires-Dist: torch (>=2.4.1,<3.0.0) ; extra == "ml" or extra == "all"
 Requires-Dist: tqdm (>=4.66.2,<5.0.0)
-Requires-Dist: voila (>=0.5.6,<0.6.0) ; extra == "analytics"
-Requires-Dist: websocket-client (>=1.7.0,<2.0.0)
+Requires-Dist: trogon (>=0.6.0,<0.7.0)
+Requires-Dist: tsfresh (>=0.20.3,<0.21.0) ; extra == "fe" or extra == "all"
+Requires-Dist: voila (>=0.5.7,<0.6.0) ; extra == "stats" or extra == "all"
+Requires-Dist: websocket-client (>=1.8.0,<2.0.0)
 Project-URL: Documentation, https://pfund-docs.pfund.ai
 Project-URL: Repository, https://github.com/PFund-Software-Ltd/pfund
 Description-Content-Type: text/markdown
 
-# PFund: Algo-Trading Framework for Machine Learning, TradFi, CeFi and DeFi ready.
+# PFund: A Complete Algo-Trading Framework powered by Machine Learning and Data Engineering, TradFi, CeFi and DeFi ready.
 
+[![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?style=social)
 ![PyPI downloads](https://img.shields.io/pypi/dm/pfund)
 [![PyPI](https://img.shields.io/pypi/v/pfund.svg)](https://pypi.org/project/pfund)
 ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/pfund)
-[![Jupyter Book Badge](https://raw.githubusercontent.com/PFund-Software-Ltd/pfund/main/docs/images/jupyterbook.svg
-)](https://jupyterbook.org)
+<!-- [![Jupyter Book Badge](https://raw.githubusercontent.com/PFund-Software-Ltd/pfund/main/docs/images/jupyterbook.svg
+)](https://jupyterbook.org) -->
+[![marimo](https://marimo.io/shield.svg)](https://marimo.io)
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 
 [TradFi]: https://www.techopedia.com/definition/traditional-finance-tradfi
@@ -66,36 +79,42 @@ Description-Content-Type: text/markdown
 [FirstRate Data]: https://firstratedata.com
 [Mantine UI]: https://ui.mantine.dev/
 
-PFund (/piː fʌnd/), which stands for "**Personal Fund**", is an **algo-trading framework** designed for using **machine learning** models to trade across [TradFi] (Traditional Finance, e.g. **Interactive Brokers**), [CeFi] (Centralized Finance, e.g. Binance) and [DeFi] (Decentralized Finance, e.g. [dYdX]), or in simple terms, **Stocks** and **Cryptos**.
+## Problem
+Machine learning (**AI**) and data engineering (**Big Data**) fields are advancing every year, but everyday traders are **not able to enjoy the benefits** of these improvements, leading to a **widening gap** between retail traders and professional traders.
 
-PFund allows traders to:
-- perform vectorized or event-driven backtesting with
-  - different resolutions of data, e.g. orderbook data, tick data, bar data etc.
-  - different data tools, e.g. pandas, [polars] etc.
-- train machine learning models using their favorite frameworks, i.e. PFund is **ML-framework agnostic**
-- tune strategy (hyper)parameters by splitting data into training sets, development sets and test sets
-- go from backtesting to live trading by just changing **ONE line of code!!**
-- execute trades manually/semi-manually via a trading app (frontend+backend)
+## Solution
+A modern algo-trading framework is needed to **bridge the gap** between algo-trading, machine learning and data engineering, empowering retail traders with state-of-the-art machine learning models and data engineering tools so that traders only need to focus on strategy research and the framework takes care of the rest.
 
-It is created to enable trading for [PFund.ai] - a trading platform that bridges algo-trading and manual trading using AI (LLM).
+---
+PFund (/piː fʌnd/), which stands for "**Personal Fund**", is an **algo-trading framework** designed for using **machine learning** models natively to trade across [TradFi] (Traditional Finance, e.g. **Interactive Brokers**), [CeFi] (Centralized Finance, e.g. Binance) and [DeFi] (Decentralized Finance, e.g. [dYdX]), or in simple terms, **Stocks** and **Cryptos**.
 
-Since PFund's sole purpose is for trading only, for all the data work, there is a separate library to handle that: \
+## Core Features
+- [x] Supports vectorized and event-driven backtesting with different resolutions of data, e.g. tick data, second data and minute data etc.
+- [x] Allows choosing your preferred data tool, e.g. pandas, polars, pyspark etc.
+- [x] Supports machine learning models, features, technical analysis indicators
+- [x] Trains machine learning models using your favorite frameworks, i.e. PFund is **ML-framework agnostic**
+- [x] Offers **LEGO-style** strategy and model building, allowing strategies to add other strategies, models to add other models
+- [x] Streamlines the algo-trading flow, from vectorized backtesting for strategy prototyping and event-driven backtesting for strategy development, to live trading for strategy deployment
+- [x] Enables parallel data processing, e.g. Interactive Brokers and Binance each have their own process for receiving data feeds
+- [x] Switches from backtesting to live trading by just changing **ONE line of code!!**
+- [ ] Features a modern frontend using [Mantine UI] and TradingView's Charts library
+- [ ] Supports manual/semi-manual trading via a trading app
+
+> As PFund is for trading only, for all the data workloads, there is a separate library to handle that:\
 [PFeed] - Data pipeline for algo-trading, helping traders in getting real-time and historical data, and storing them in a local data lake for quantitative research.
 
+---
 
 <details>
 <summary>Table of Contents</summary>
 
-- [Project Status](#project-status)
-- [Mission](#mission)
-- [Core Features](#core-features)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
   - [Backtesting](#backtesting)
   - [Live Trading](#live-trading)
   - [Parameter Training / Hyperparameter Tuning](#parameter-training--hyperparameter-tuning)
   - [Building LEGO-Style Strategy and Model](#building-lego-style-strategy-and-model)
-- [Model Hub](#model-hub)
+- [PFund Hub](#pfund-hub)
 - [Supported Trading Venues](#supported-trading-venues)
 - [Related Projects](#related-projects)
 - [Disclaimer](#disclaimer)
@@ -103,57 +122,23 @@ Since PFund's sole purpose is for trading only, for all the data work, there is
 </details>
 
 
-## Project Status
-**_Caution: PFund is at a VERY EARLY stage, use it at your own risk._**
-
-PFund is currently under active development, the framework design will be prioritized first over
-stability and scalability.
-
-Please note that the available version is a *dev* version, not a *stable* one. \
-You are encouraged to play with the *dev* version, but only use it when a *stable* version is released.
-
-> PFund for the time being **_only supports vectorized backtesting_** using [Bybit] and Yahoo Finance data for testing purpose.
-
-
-## Mission
-As an algo-trader, if you aim to quickly try out some trading ideas to see if they work, and if they do, deploy them for live traidng, it is actually not a trivial task since it involves multiple stages:
-- Ideation
-- Strategy development
-- Backtesting
-- Model development (if using machine learning)
-- Model training (if using machine learning)
-- Parameter training / hyperparameter tuning
-- Strategy deployment
-- Portfolio monitoring
-
-This overview already omits some intricate steps, such as data handling and API integration.
-
-> PFund's mission is to **_enable traders to concentrate solely on strategy formulation_** while the framework manages the rest. With PFund serving as the core trade engine, it empowers retail traders to have a fund management experience on [PFund.ai] as if they are operating their personal hedge fund, hence the name *PFund*.
-
-
-## Core Features
-- [x] Easily switch environments with just one line of code, transitioning from backtesting to live trading
-- [x] Supports machine learning models, features, technical analysis indicators
-- [x] Both Strategy() and Model() are treated as first-class citizens
-- [x] Offers LEGO-style strategy and model building, allowing strategies to add other strategies, models to add other models
-- [x] Streamlines the algo-trading flow, from vectorized backtesting for strategy prototyping and event-driven backtesting for strategy development, to live trading for strategy deployment
-- [x] Enables parallel data processing, e.g. Interactive Brokers and Binance each have their own process for receiving data feeds
-- [ ] Allows choosing your preferred data tool, e.g. pandas, polars, pyspark etc.
-- [ ] Features a modern frontend using [Mantine UI] and TradingView's Charts library
-- [ ] Supports manual/semi-manual trading using the frontend
-
-
 ## Installation
 
 ### Using [Poetry] (Recommended)
 ```bash
-# [RECOMMENDED]: trading + backtest
-poetry add "pfund[data]"
+# [RECOMMENDED]: Trading + Backtesting + Machine Learning + Feature Engineering (e.g. feast, tsfresh, ta) + Analytics
+poetry add "pfund[all]"
+
+# [Trading + Backtesting + Machine Learning + Feature Engineering]:
+poetry add "pfund[data,ml,fe]"
 
-# [Machine Learning]: trading + backtest + machine learning/technical analysis
+# [Trading + Backtesting + Machine Learning]:
 poetry add "pfund[data,ml]"
 
-# only trading
+# [Trading + Backtesting]:
+poetry add "pfund[data]"
+
+# [Trading only]:
 poetry add pfund
 
 # update to the latest version:
@@ -162,7 +147,8 @@ poetry update pfund
 
 ### Using Pip
 ```bash
-pip install pfund
+# same as above, you can choose to install "pfund[all]", "pfund[data,ml,fe]", "pfund[data,ml]", "pfund[data]" or "pfund"
+pip install "pfund[all]"
 
 # install the latest version:
 pip install -U pfund
@@ -253,12 +239,13 @@ engine.run()
 ```
 
 
-## Model Hub
-Imagine a space where algo-traders can share their machine learning models with one another.
+## PFund Hub
+Imagine a space where algo-traders can share their trading strategies and machine learning models with one another.
 Strategy and model development could be so much faster since you can build on top of an existing working model.
-> Model Hub is coming soon on [PFund.ai], Stay Tuned!
 
 
+---
+
 ## Supported Trading Venues
 | Trading Venue             | Vectorized Backtesting | Event-Driven Backtesting | Paper Trading | Live Trading |
 | ------------------------- | ---------------------- | ------------------------ | ------------- | ------------ |

{pfund-0.0.1.dev13 → pfund-0.0.2.dev1}/README.md

@@ -1,11 +1,13 @@
-# PFund: Algo-Trading Framework for Machine Learning, TradFi, CeFi and DeFi ready.
+# PFund: A Complete Algo-Trading Framework powered by Machine Learning and Data Engineering, TradFi, CeFi and DeFi ready.
 
+[![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?style=social)
 ![PyPI downloads](https://img.shields.io/pypi/dm/pfund)
 [![PyPI](https://img.shields.io/pypi/v/pfund.svg)](https://pypi.org/project/pfund)
 ![PyPI - Support Python Versions](https://img.shields.io/pypi/pyversions/pfund)
-[![Jupyter Book Badge](https://raw.githubusercontent.com/PFund-Software-Ltd/pfund/main/docs/images/jupyterbook.svg
-)](https://jupyterbook.org)
+<!-- [![Jupyter Book Badge](https://raw.githubusercontent.com/PFund-Software-Ltd/pfund/main/docs/images/jupyterbook.svg
+)](https://jupyterbook.org) -->
+[![marimo](https://marimo.io/shield.svg)](https://marimo.io)
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 
 [TradFi]: https://www.techopedia.com/definition/traditional-finance-tradfi
@@ -23,36 +25,42 @@
 [FirstRate Data]: https://firstratedata.com
 [Mantine UI]: https://ui.mantine.dev/
 
-PFund (/piː fʌnd/), which stands for "**Personal Fund**", is an **algo-trading framework** designed for using **machine learning** models to trade across [TradFi] (Traditional Finance, e.g. **Interactive Brokers**), [CeFi] (Centralized Finance, e.g. Binance) and [DeFi] (Decentralized Finance, e.g. [dYdX]), or in simple terms, **Stocks** and **Cryptos**.
+## Problem
+Machine learning (**AI**) and data engineering (**Big Data**) fields are advancing every year, but everyday traders are **not able to enjoy the benefits** of these improvements, leading to a **widening gap** between retail traders and professional traders.
 
-PFund allows traders to:
-- perform vectorized or event-driven backtesting with
-  - different resolutions of data, e.g. orderbook data, tick data, bar data etc.
-  - different data tools, e.g. pandas, [polars] etc.
-- train machine learning models using their favorite frameworks, i.e. PFund is **ML-framework agnostic**
-- tune strategy (hyper)parameters by splitting data into training sets, development sets and test sets
-- go from backtesting to live trading by just changing **ONE line of code!!**
-- execute trades manually/semi-manually via a trading app (frontend+backend)
+## Solution
+A modern algo-trading framework is needed to **bridge the gap** between algo-trading, machine learning and data engineering, empowering retail traders with state-of-the-art machine learning models and data engineering tools so that traders only need to focus on strategy research and the framework takes care of the rest.
 
-It is created to enable trading for [PFund.ai] - a trading platform that bridges algo-trading and manual trading using AI (LLM).
+---
+PFund (/piː fʌnd/), which stands for "**Personal Fund**", is an **algo-trading framework** designed for using **machine learning** models natively to trade across [TradFi] (Traditional Finance, e.g. **Interactive Brokers**), [CeFi] (Centralized Finance, e.g. Binance) and [DeFi] (Decentralized Finance, e.g. [dYdX]), or in simple terms, **Stocks** and **Cryptos**.
 
-Since PFund's sole purpose is for trading only, for all the data work, there is a separate library to handle that: \
+## Core Features
+- [x] Supports vectorized and event-driven backtesting with different resolutions of data, e.g. tick data, second data and minute data etc.
+- [x] Allows choosing your preferred data tool, e.g. pandas, polars, pyspark etc.
+- [x] Supports machine learning models, features, technical analysis indicators
+- [x] Trains machine learning models using your favorite frameworks, i.e. PFund is **ML-framework agnostic**
+- [x] Offers **LEGO-style** strategy and model building, allowing strategies to add other strategies, models to add other models
+- [x] Streamlines the algo-trading flow, from vectorized backtesting for strategy prototyping and event-driven backtesting for strategy development, to live trading for strategy deployment
+- [x] Enables parallel data processing, e.g. Interactive Brokers and Binance each have their own process for receiving data feeds
+- [x] Switches from backtesting to live trading by just changing **ONE line of code!!**
+- [ ] Features a modern frontend using [Mantine UI] and TradingView's Charts library
+- [ ] Supports manual/semi-manual trading via a trading app
+
+> As PFund is for trading only, for all the data workloads, there is a separate library to handle that:\
 [PFeed] - Data pipeline for algo-trading, helping traders in getting real-time and historical data, and storing them in a local data lake for quantitative research.
 
+---
 
 <details>
 <summary>Table of Contents</summary>
 
-- [Project Status](#project-status)
-- [Mission](#mission)
-- [Core Features](#core-features)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
   - [Backtesting](#backtesting)
   - [Live Trading](#live-trading)
   - [Parameter Training / Hyperparameter Tuning](#parameter-training--hyperparameter-tuning)
   - [Building LEGO-Style Strategy and Model](#building-lego-style-strategy-and-model)
-- [Model Hub](#model-hub)
+- [PFund Hub](#pfund-hub)
 - [Supported Trading Venues](#supported-trading-venues)
 - [Related Projects](#related-projects)
 - [Disclaimer](#disclaimer)
@@ -60,57 +68,23 @@ Since PFund's sole purpose is for trading only, for all the data work, there is
 </details>
 
 
-## Project Status
-**_Caution: PFund is at a VERY EARLY stage, use it at your own risk._**
-
-PFund is currently under active development, the framework design will be prioritized first over
-stability and scalability.
-
-Please note that the available version is a *dev* version, not a *stable* one. \
-You are encouraged to play with the *dev* version, but only use it when a *stable* version is released.
-
-> PFund for the time being **_only supports vectorized backtesting_** using [Bybit] and Yahoo Finance data for testing purpose.
-
-
-## Mission
-As an algo-trader, if you aim to quickly try out some trading ideas to see if they work, and if they do, deploy them for live traidng, it is actually not a trivial task since it involves multiple stages:
-- Ideation
-- Strategy development
-- Backtesting
-- Model development (if using machine learning)
-- Model training (if using machine learning)
-- Parameter training / hyperparameter tuning
-- Strategy deployment
-- Portfolio monitoring
-
-This overview already omits some intricate steps, such as data handling and API integration.
-
-> PFund's mission is to **_enable traders to concentrate solely on strategy formulation_** while the framework manages the rest. With PFund serving as the core trade engine, it empowers retail traders to have a fund management experience on [PFund.ai] as if they are operating their personal hedge fund, hence the name *PFund*.
-
-
-## Core Features
-- [x] Easily switch environments with just one line of code, transitioning from backtesting to live trading
-- [x] Supports machine learning models, features, technical analysis indicators
-- [x] Both Strategy() and Model() are treated as first-class citizens
-- [x] Offers LEGO-style strategy and model building, allowing strategies to add other strategies, models to add other models
-- [x] Streamlines the algo-trading flow, from vectorized backtesting for strategy prototyping and event-driven backtesting for strategy development, to live trading for strategy deployment
-- [x] Enables parallel data processing, e.g. Interactive Brokers and Binance each have their own process for receiving data feeds
-- [ ] Allows choosing your preferred data tool, e.g. pandas, polars, pyspark etc.
-- [ ] Features a modern frontend using [Mantine UI] and TradingView's Charts library
-- [ ] Supports manual/semi-manual trading using the frontend
-
-
 ## Installation
 
 ### Using [Poetry] (Recommended)
 ```bash
-# [RECOMMENDED]: trading + backtest
-poetry add "pfund[data]"
+# [RECOMMENDED]: Trading + Backtesting + Machine Learning + Feature Engineering (e.g. feast, tsfresh, ta) + Analytics
+poetry add "pfund[all]"
+
+# [Trading + Backtesting + Machine Learning + Feature Engineering]:
+poetry add "pfund[data,ml,fe]"
 
-# [Machine Learning]: trading + backtest + machine learning/technical analysis
+# [Trading + Backtesting + Machine Learning]:
 poetry add "pfund[data,ml]"
 
-# only trading
+# [Trading + Backtesting]:
+poetry add "pfund[data]"
+
+# [Trading only]:
 poetry add pfund
 
 # update to the latest version:
@@ -119,7 +93,8 @@ poetry update pfund
 
 ### Using Pip
 ```bash
-pip install pfund
+# same as above, you can choose to install "pfund[all]", "pfund[data,ml,fe]", "pfund[data,ml]", "pfund[data]" or "pfund"
+pip install "pfund[all]"
 
 # install the latest version:
 pip install -U pfund
@@ -210,12 +185,13 @@ engine.run()
 ```
 
 
-## Model Hub
-Imagine a space where algo-traders can share their machine learning models with one another.
+## PFund Hub
+Imagine a space where algo-traders can share their trading strategies and machine learning models with one another.
 Strategy and model development could be so much faster since you can build on top of an existing working model.
-> Model Hub is coming soon on [PFund.ai], Stay Tuned!
 
 
+---
+
 ## Supported Trading Venues
 | Trading Venue             | Vectorized Backtesting | Event-Driven Backtesting | Paper Trading | Live Trading |
 | ------------------------- | ---------------------- | ------------------------ | ------------- | ------------ |

{pfund-0.0.1.dev13 → pfund-0.0.2.dev1}/pfund/CONTRIBUTING.md

@@ -3,7 +3,7 @@
 git clone git@github.com:PFund-Software-Ltd/pfund.git
 cd pfund
 git submodule update --init --recursive
-poetry install --all-extras
+poetry install --with dev,test,doc --all-extras
 ```
 
 ## Pull updates

pfund-0.0.2.dev1/pfund/__init__.py

@@ -0,0 +1,32 @@
+import sys
+from importlib.metadata import version
+
+from pfund.config_handler import configure
+from pfund.const.aliases import ALIASES as aliases
+from pfund.const.paths import PROJ_PATH
+# add python path so that for files like "ibapi" (official python code from IB) can find their modules
+sys.path.append(f'{PROJ_PATH}/externals')
+from pfund.engines import BacktestEngine, TradeEngine, TrainEngine, SandboxEngine
+from pfund.strategies import Strategy
+from pfund.models import Model, Feature, PytorchModel, SklearnModel
+from pfund.indicators import Indicator, TalibIndicator, TaIndicator
+
+
+__version__ = version('pfund')
+__all__ = (
+    '__version__',
+    'configure', 
+    'aliases',
+    'BacktestEngine', 
+    'TradeEngine',
+    'TrainEngine', 
+    'SandboxEngine',
+    'Strategy', 
+    'Model',
+    'Feature',
+    'PytorchModel',
+    'SklearnModel',
+    'Indicator',
+    'TalibIndicator',
+    'TaIndicator',
+)

{pfund-0.0.1.dev13 → pfund-0.0.2.dev1}/pfund/accounts/account_base.py

@@ -20,4 +20,16 @@ class BaseAccount:
         return f'Broker={self.bkr}|Account={self.name}|Strategy={self.strat}'
 
     def __repr__(self):
-        return f'{self.bkr}-{self.name}'
+        return f'{self.bkr}-{self.name}'
+
+    def __eq__(self, other):
+        if not isinstance(other, BaseAccount):
+            return NotImplemented  # Allow other types to define equality with BaseProduct
+        return (
+            self.env == other.env
+            and self.bkr == other.bkr
+            and self.name == other.name
+        )
+        
+    def __hash__(self):
+        return hash((self.env, self.bkr, self.name))

pfund-0.0.2.dev1/pfund/accounts/account_crypto.py

@@ -0,0 +1,33 @@
+from pfund.accounts.account_base import BaseAccount
+from pfund.const.common import SUPPORTED_BYBIT_ACCOUNT_TYPES
+
+
+class CryptoAccount(BaseAccount):
+    def __init__(self, env, exch, key='', secret='', acc='', **kwargs):
+        self.exch = exch.upper()
+        if self.exch == 'BYBIT':
+            assert 'account_type' in kwargs and kwargs['account_type'].upper() in SUPPORTED_BYBIT_ACCOUNT_TYPES, \
+            f"kwarg 'account_type' must be provided for exchange {self.exch}, {SUPPORTED_BYBIT_ACCOUNT_TYPES=}"
+        super().__init__(env, 'CRYPTO', acc=acc, key=key, secret=secret, **kwargs)
+        if self.env in ['PAPER', 'LIVE']:
+            assert key, f'API `key` must be provided for {self.env} trading environment'
+            assert secret, f'API `secret` must be provided for {self.env} trading environment'
+
+    def __str__(self):
+        return f'Broker={self.bkr}|Exchange={self.exch}|Account={self.name}|Strategy={self.strat}'
+
+    def __repr__(self):
+        return f'{self.bkr}-{self.exch}-{self.name}'
+   
+    def __eq__(self, other):
+        if not isinstance(other, CryptoAccount):
+            return NotImplemented  # Allow other types to define equality with BaseProduct
+        return (
+            self.env == other.env
+            and self.bkr == other.bkr
+            and self.exch == other.exch
+            and self.name == other.name
+        )
+     
+    def __hash__(self):
+        return hash((self.env, self.bkr, self.exch, self.name))

{pfund-0.0.1.dev13 → pfund-0.0.2.dev1}/pfund/analyzer.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+import json
 from pathlib import Path
 
 from typing import TYPE_CHECKING
@@ -23,9 +24,22 @@ class Analyzer:
     spreadsheet_path = Path(config.spreadsheet_path)
     dashboard_path = Path(config.dashboard_path)
     
-    def __init__(self, data: dict | None=None):
-        self.data = data or {}
+    def __init__(self, data: dict | None=None, backtest_name=''):
+        self._data = data or {}
+        if backtest_name:
+            self._data = self._load_backtest_history(backtest_name)
+            if data:
+                print('Warning: backtest_name is provided, but data is also provided, data will be ignored')
         
+    def _load_backtest_history(self, backtest_name: str) -> dict:
+        if '.json' not in backtest_name:
+            backtest_name += '.json'
+        file_path = os.path.join(self.config.backtest_path, backtest_name)
+        backtest_history = {}
+        with open(file_path, 'r') as f:
+            backtest_history = json.load(f)
+        return backtest_history
+    
     @staticmethod
     def _is_file(template: str) -> bool:
         if '\\' in template or '/' in template:
@@ -126,7 +140,7 @@ class Analyzer:
         nb_output_file_paths = []
         if isinstance(notebooks, str):
             notebooks = [notebooks]
-        data = data or self.data
+        data = data or self._data
         if not data:
             raise ValueError("No data passed in or stored in the Analyzer instance, please pass in the data to be analyzed.")