Backtest-Reg

Backtest-Reg is a Python package designed to simplify the process of creating, running, and evaluating backtests. It offers an intuitive interface for exploring strategies and automating complex workflows.

Installation

To install the package, use the following command:

pip install backtest-reg

Usage

Every new functionality developed in this package has been interfaced so you have very little to do!

Step-by-Step Guide

1. Create a launch.py file

   Add the following lines to your launch.py file:

   from backtest_reg.main import run
   
   if __name__ == "__main__":
        run()
   

2. Run the application

   Open the terminal in the folder where the launch.py file is located and run the following command:

   streamlit run launch.py
   

   You'll see the welcome message:

   Welcome to Backtest-Reg!
   

Commands Cheat Sheet

Here's a quick reference for all coding-related commands used in Backtest-Reg:

Installation

pip install backtest-reg

Running the Application

1. Create the launch.py file:

   from backtest_reg.main import run
   
   if __name__ == "__main__":
        run()
   

2. Run the application via Streamlit:

   streamlit run launch.py
   

License

This project is licensed under the MIT License. See the LICENSE file for details.