Metadata-Version: 2.2
Name: uwqsc-backtesting-framework
Version: 2025.3.7
Summary: The University of Waterloo quantitative analysis stocks club backtesting framework repository.
Author-email: Sargun Singh Bhatti <sargunbhatti27@gmail.com>, Param Shah <paramshah07@gmail.com>, Raghav Bhasin <raghav9909@gmail.com>
Project-URL: Homepage, https://github.com/UWQSC/backtesting-framework
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: streamlit==1.43.0
Requires-Dist: uwqsc-algorithmic-trading==2025.3.7.post2

# backtesting-framework
# The University of Waterloo Quantitative Analysis Stocks Club Backtesting Framework

Welcome to the University of Waterloo Quantitative Analysis Stocks Club Backtesting Framework repository. This framework is designed to help you test and analyze various stock trading strategies using historical data.

## Features

- **Historical Data Analysis**: Import and analyze historical stock data to backtest trading strategies.
- **Strategy Implementation**: Implement and test custom trading strategies.
- **Performance Metrics**: Evaluate the performance of your strategies with various metrics.
- **Visualization**: Visualize the results of your backtests with charts and graphs.

## Getting Started

### Prerequisites

- Python 3.x
- Required Python libraries (listed in `requirements.txt`)

### Installation

1. Clone the repository:
    ```bash
    git clone https://github.com/yourusername/backtesting-framework.git
    ```
2. Navigate to the project directory:
    ```bash
    cd backtesting-framework
    ```
3. Install the required dependencies:
    ```bash
    pip install -r requirements.txt
    ```


### Usage

1. Prepare your historical data in the required format.
2. The current application runs on data in csv format and uses streamlit.
3. Run the application:
    ```python
    streamlit run main.py
    ```
4. **CSV File Access:**
    - Due to file size constraints, the CSV file 'hackathon_sample_v2.csv' used for backtesting is stored externally
    - You can download it from **[https://drive.google.com/file/d/1H3ktLEsd3Bg9A9Rx5P45OdnYMEdkX29s/view?usp=sharing]** and place it in the `data/` directory.


Happy backtesting!

