Add doc strings to the top of the scripts and oneliners for each task.

Author: niklasniedermeier

src/backtest_bay/backtest/backtest_signals.py

@@ -1,3 +1,5 @@
+"""This script deploys functions to backtest trading signals."""
+
 import math
 
 import pandas as pd

src/backtest_bay/backtest/generate_signals.py

@@ -1,3 +1,5 @@
+"""This script deploys functions to generate trading signals."""
+
 import pandas as pd
 
 

src/backtest_bay/backtest/task_backtest.py

@@ -1,3 +1,5 @@
+"""This script deploys a task to generate trading signals and backtest them."""
+
 import pandas as pd
 import pytask
 
@@ -31,6 +33,7 @@ def task_backtest(
         produces=produces,
         strategy=strategy,
     ):
+        """Task to generate signals, backtest and store results it in the bld folder."""
         stock_data = pd.read_pickle(stock_data_path)
         signals = generate_signals(data=stock_data, method=strategy)
         backtested_portfolio = backtest_signals(

src/backtest_bay/data/download_data.py

@@ -1,3 +1,5 @@
+"""This script deploys functions to download data."""
+
 from datetime import datetime
 
 import pandas as pd

src/backtest_bay/data/task_download_data.py

@@ -1,3 +1,5 @@
+"""This script deploys a task to download data."""
+
 import pytask
 
 from backtest_bay.config import BLD, PARAMS, SRC
@@ -16,6 +18,7 @@
 
     @pytask.task(id=id_download)
     def task_download_data(depends_on=scripts, produces=produces, param=row):
+        """Task to download data and store it in the bld folder."""
         data = download_data(
             symbol=param.stock,
             start_date=param.start_date,

src/backtest_bay/plot/plot_portfolio.py

@@ -1,3 +1,5 @@
+"""This script deploys functions to visualize the backtested portfolio."""
+
 import numpy as np
 import pandas as pd
 import plotly.graph_objects as go

src/backtest_bay/plot/plot_signals.py

@@ -1,3 +1,5 @@
+"""This script deploys functions to visualize the trading signals."""
+
 import pandas as pd
 import plotly.graph_objects as go
 from plotly.subplots import make_subplots

src/backtest_bay/plot/task_plot.py

@@ -1,3 +1,5 @@
+"""This script deploys a task to plot the backtested portfolio and trading signals."""
+
 import pandas as pd
 import pytask
 
@@ -32,6 +34,7 @@ def task_plot(
         produces=produces,
         id_backtest=id_backtest,
     ):
+        """Task to plot the backtested portfolio and trading signals."""
         portfolio = pd.read_pickle(backtest_path)
         fig = plot_signals(portfolio, id_backtest)
         fig.write_html(produces.get("plot_signals"))