The pwb-toolbox
package is designed to provide tools and resources for systematic trading strategies. It includes datasets and strategy ideas to assist in developing and backtesting trading algorithms. For detailed instructions on how to use this package effectively, please refer to the associated Substack publication by visiting: https://blog.paperswithbacktest.com/.
To install the pwb-toolbox package:
pip install pwb-toolbox
This package requires Python 3.10 or higher.
To login to Huggingface Hub with Access Token
huggingface-cli login
The pwb-toolbox
package offers a range of functionalities for systematic trading analysis. Here are some examples of how to utilize the package:
- Import
pwb_toolbox.datasets
and sequentially loads datasets for different asset classes, such as bonds, commodities, cryptocurrencies, ETFs, forex, indices, and stocks, using theload_dataset
function:
import pwb_toolbox.datasets as pwb_ds
df = pwb_ds.get_pricing(["AAPL", "MSFT", "GOOGL"])
df = pwb_ds.load_dataset("Bonds-Daily-Price")
df = pwb_ds.load_dataset("Commodities-Daily-Price")
df = pwb_ds.load_dataset("Cryptocurrencies-Daily-Price")
df = pwb_ds.load_dataset("ETFs-Daily-Price")
df = pwb_ds.load_dataset("Forex-Daily-Price")
df = pwb_ds.load_dataset("Indices-Daily-Price")
df = pwb_ds.load_dataset("Stocks-Daily-Price")
- Load daily stock price data for specific symbols using the load_dataset function. The first call retrieves data for Apple and Microsoft. The second call retrieves the same stocks but without price adjustments (
adjust=False
). The third call loads daily price data for the S&P 500 index:
import pwb_toolbox.datasets as pwb_ds
df = pwb_ds.load_dataset(
"Stocks-Daily-Price",
["AAPL", "MSFT"],
)
df = pwb_ds.load_dataset(
"Stocks-Daily-Price",
["AAPL", "MSFT"],
adjust=False,
)
df = pwb_ds.load_dataset(
"Stocks-Daily-Price",
["sp500"],
)
- The
extend=True
argument instructs the function to return an extended historical data using indices, commodities, and bonds data.
import pwb_toolbox.datasets as pwb_ds
df = pwb_ds.load_dataset(
"ETFs-Daily-Price",
["SPY", "IEF"],
extend=True,
)
- The argument
rate_to_price=False
specifies that bond yield rates should not be converted to price values in the returned data:
import pwb_toolbox.datasets as pwb_ds
df = pwb_ds.load_dataset(
"Bonds-Daily-Price",
["US10Y"],
rate_to_price=False,
)
- The argument
to_usd=False
indicates that the data should not be converted to U.S. dollars, implying that it might be available in another currency.
import pwb_toolbox.datasets as pwb_ds
df = pwb_ds.load_dataset(
"Indices-Daily-Price",
["US10Y"],
to_usd=False,
)
The pwb_toolbox.backtest
module offers simple building blocks for running
Backtrader simulations. Alpha models generate Insight
objects which are turned
into portfolio weights and executed via Backtrader orders.
from pwb_toolbox.backtest.examples import GoldenCrossAlpha, EqualWeightPortfolio
from pwb_toolbox.backtest import run_backtest
run_backtest(["SPY", "QQQ"], GoldenCrossAlpha(), EqualWeightPortfolio(), start="2015-01-01")
After running a backtest you can analyze the returned equity series using the
pwb_toolbox.performance
module.
from pwb_toolbox.backtest.examples import GoldenCrossAlpha, EqualWeightPortfolio
from pwb_toolbox.backtest import run_backtest
from pwb_toolbox.performance import total_return, cagr
from pwb_toolbox.performance.plots import plot_equity_curve
result, equity = run_backtest(
["SPY", "QQQ"],
GoldenCrossAlpha(),
EqualWeightPortfolio(),
start="2015-01-01",
)
print("Total return:", total_return(equity))
print("CAGR:", cagr(equity))
plot_equity_curve(equity)
Plotting utilities require matplotlib
; some metrics also need pandas
.
run_ib_strategy
streams Interactive Brokers data and orders. Install ibapi
and either atreyu-backtrader-api
or ib_insync
.
from pwb_toolbox.backtest import IBConnector, run_ib_strategy
from pwb_toolbox.backtest.example.engine import SimpleIBStrategy
data_cfg = [{"dataname": "AAPL", "name": "AAPL"}]
run_ib_strategy(
SimpleIBStrategy,
data_cfg,
host="127.0.0.1",
port=7497,
client_id=1,
)
Configure host
, port
, and client_id
to match your TWS or Gateway settings. Test with an Interactive Brokers paper account before trading live.
Contributions to the pwb-toolbox
package are welcome! If you have any improvements, new datasets, or strategy ideas to share, please follow these guidelines:
- Fork the repository and create a new branch for your feature.
- Make your changes and ensure they adhere to the package's coding style.
- Write tests to validate the functionality or provide sample usage examples.
- Submit a pull request, clearly explaining the purpose and benefits of your contribution.
Please note that all contributions are subject to review and approval by the maintainers.
To build the package, run:
python -m pip install --upgrade build
rm -r dist
python -m build
To upload the package to PyPI, run:
twine upload dist/*
The pwb-toolbox
package is released under the MIT license. See the LICENSE file for more details.
For any questions, issues, or suggestions regarding the pwb-toolbox
package, please contact the maintainers or create an issue on the repository. We appreciate your feedback and involvement in improving the package.
Happy trading!