Skip to content

Commit 514cbda

Browse files
Add description of input parameters to config.py.
1 parent 17aa87c commit 514cbda

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

src/backtest_bay/config.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
"""All the general configuration of the project."""
1+
"""Configuration file for backtesting trading strategies.
2+
3+
Parameters:
4+
STOCKS (list of str): List of stock symbols to fetch data for.
5+
START_DATE (str): Start date for fetching historical stock data
6+
(format: "YYYY-MM-DD").
7+
END_DATE (str): End date for fetching historical stock data (format: "YYYY-MM-DD").
8+
INTERVAL (str): Time interval for stock data (e.g., "1d", "1wk", "1mo").
9+
STRATEGIES (list of str): List of trading strategies to evaluate.
10+
Possible values: ["bollinger", "macd", "roc", "rsi"].
11+
INITIAL_CASH (int): Initial amount of cash available for trading.
12+
TAC (float): Transaction cost per trade, represented as a fraction
13+
(e.g., 0.005 for 0.5%).
14+
TRADE_PCT (float): Percentage of available capital to invest per trade
15+
(e.g., 0.05 for 5%).
16+
"""
217

318
from pathlib import Path
419

0 commit comments

Comments
 (0)