pfund 0.0.1__tar.gz

pfund-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2024] [Stephen Yau, PFund.ai]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pfund-0.0.1/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.1
+Name: pfund
+Version: 0.0.1
+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
+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: all
+Provides-Extra: analytics
+Provides-Extra: boost
+Provides-Extra: data
+Provides-Extra: fe
+Provides-Extra: ml
+Requires-Dist: click (>=8.1.7,<9.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: ipython (>=8.27.0,<9.0.0)
+Requires-Dist: mlflow (>=2.16.1,<3.0.0) ; extra == "ml" or extra == "all"
+Requires-Dist: numba (>=0.60.0,<0.61.0) ; extra == "boost" or extra == "all"
+Requires-Dist: orjson (>=3.10.7,<4.0.0) ; extra == "data" or extra == "all"
+Requires-Dist: papermill (>=2.6.0,<3.0.0) ; extra == "analytics" 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 == "analytics" or extra == "all"
+Requires-Dist: platformdirs (>=4.3.3,<5.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: python-telegram-bot (>=21.5,<22.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Requires-Dist: pyzmq (>=26.2.0,<27.0.0) ; extra == "data" or extra == "all"
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: rich (>=13.8.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: 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.5,<5.0.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 == "analytics" 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: A Complete Algo-Trading Framework powered by Machine Learning and Data Engineering, TradFi, CeFi and DeFi ready.
+
+![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)
+[![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
+[CeFi]: https://www.techopedia.com/definition/centralized-finance-cefi
+[DeFi]: https://www.coinbase.com/learn/crypto-basics/what-is-defi
+[pytrade.org]: https://pytrade.org
+[dYdX]: https://dydx.exchange
+[polars]: https://pola.rs/
+[PFund.ai]: https://pfund.ai
+[PFeed]: https://github.com/PFund-Software-Ltd/pfeed
+[Bybit]: https://bybit.com/
+[PyTorch]: https://pytorch.org/
+[Poetry]: https://python-poetry.org
+[Futu]: https://www.futunn.com
+[FirstRate Data]: https://firstratedata.com
+[Mantine UI]: https://ui.mantine.dev/
+
+## 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.
+
+## 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.
+
+---
+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**.
+
+## 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>
+
+- [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)
+- [PFund Hub](#pfund-hub)
+- [Supported Trading Venues](#supported-trading-venues)
+- [Related Projects](#related-projects)
+- [Disclaimer](#disclaimer)
+
+</details>
+
+
+## Installation
+
+### Using [Poetry] (Recommended)
+```bash
+# [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]"
+
+# [Trading + Backtesting + Machine Learning]:
+poetry add "pfund[data,ml]"
+
+# [Trading + Backtesting]:
+poetry add "pfund[data]"
+
+# [Trading only]:
+poetry add pfund
+
+# update to the latest version:
+poetry update pfund
+```
+
+### Using Pip
+```bash
+# 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
+```
+
+### Checking your installation
+```bash
+$ pfund --version
+```
+
+
+## Quick Start
+### Backtesting
+```python
+import pfund as pf
+
+# NOTE: for more exciting strategies, please visit pfund.ai
+class YourStrategy(pf.Strategy):
+    # triggered by bar/kline data (e.g. 1-minute data)
+    def on_bar(self):
+        # write your trading logic here
+        pass
+
+
+engine = pf.BacktestEngine(mode='vectorized')
+strategy = engine.add_strategy(YourStrategy(), name='your_strategy')
+strategy.add_data(
+  'IB', 'AAPL', 'USD', 'STK', resolutions=['1d'],
+  backtest={
+    # NOTE: since IB does not provide any historical data for backtesting purpose, use data from 'YAHOO_FINANCE'
+    'data_source': 'YAHOO_FINANCE',
+    'start_date': '2024-01-01',
+    'end_date': '2024-02-01',
+  }
+)
+engine.run()
+```
+
+
+### Live Trading
+> Just change one line of code, from '**BacktestEngine**' to '**TradeEngine**'. BOOM! you can now start live trading.
+```python
+import pfund as pf
+
+engine = pf.TradeEngine(env='LIVE')
+strategy = engine.add_strategy(YourStrategy(), name='your_strategy')
+strategy.add_data(
+  'IB', 'AAPL', 'USD', 'STK', resolutions=['1d'],
+  # for convenience, you can keep the kwarg `backtest`, `TradeEngine` will ignore it
+  backtest={
+    # NOTE: since IB does not provide any historical data for backtesting purpose, use data from 'YAHOO_FINANCE'
+    'data_source': 'YAHOO_FINANCE',
+    'start_date': '2024-01-01',
+    'end_date': '2024-02-01',
+  }
+)
+engine.run()
+```
+
+### Parameter Training / Hyperparameter Tuning
+> The correct term should be "Hyperparameter Tuning", but since not all traders are familiar with machine learning, the framework uses a more well-known term "training".
+
+```python
+import pfund as pf
+
+engine = pf.TrainEngine()
+strategy = engine.add_strategy(...)
+strategy.add_data(...)
+strategy.add_indicator(...)
+engine.run()
+```
+
+### Building LEGO-Style Strategy and Model
+```python
+import pfund as pf
+
+engine = pf.TradeEngine(env='LIVE')
+strategy = engine.add_strategy(...)
+strategy.add_data(...)
+model = strategy.add_model(...)
+
+model.add_data(...)  # using different data than strategy's
+sub_model = model.add_model(...)  # YES, model can add another model to its use
+# You can keep going: 
+# sub_sub_model = sub_model.add_model(...)
+
+engine.run()
+```
+
+
+## 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.
+
+
+---
+
+## Supported Trading Venues
+| Trading Venue             | Vectorized Backtesting | Event-Driven Backtesting | Paper Trading | Live Trading |
+| ------------------------- | ---------------------- | ------------------------ | ------------- | ------------ |
+| Bybit                     | 🟢                     | 🟡                       | 🟡            | 🟡           |
+| *Interactive Brokers (IB) | 🟡                     | 🟡                       | 🟡            | 🟡           |
+| Binance                   | 🔴                     | 🔴                       | 🔴            | 🔴           |
+| OKX                       | 🔴                     | 🔴                       | 🔴            | 🔴           |
+| *Alpaca                   | 🔴                     | 🔴                       | 🔴            | 🔴           |
+| *[Futu]                   | 🔴                     | 🔴                       | 🔴            | 🔴           |
+| dYdX                      | 🔴                     | 🔴                       | 🔴            | 🔴           |
+
+🟢 = finished \
+🟡 = in progress \
+🔴 = todo \
+\* = use a **_separate data source_** (e.g. [FirstRate Data]) for backtesting
+
+
+## Related Projects
+- [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.
+- [PyTrade.org] - A curated list of Python libraries and resources for algorithmic trading.
+
+
+## Disclaimer
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This algo-trading framework is intended for educational and research purposes only. It should not be used for real trading without understanding the risks involved. Trading in financial markets involves significant risk, and there is always the potential for loss. Your trading results may vary. No representation is being made that any account will or is likely to achieve profits or losses similar to those discussed on this platform.
+
+The developers of this framework are not responsible for any financial losses incurred from using this software. Users should conduct their due diligence and consult with a professional financial advisor before engaging in real trading activities.