Metadata-Version: 2.4
Name: hypertrial
Version: 0.1.0
Summary: Bitcoin Dollar-Cost Averaging (DCA) Backtest Framework
Home-page: https://github.com/hypertrial/hypertrial
Author: Matt Faltyn
Author-email: faltyn.matthew@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=1.3.0
Requires-Dist: numpy>=1.20.0
Requires-Dist: matplotlib>=3.4.0
Requires-Dist: coinmetrics-api-client>=2024.2.6.16
Requires-Dist: pytest>=6.2.0
Requires-Dist: pandas_datareader>=0.10.0
Requires-Dist: scipy>=1.6.0
Requires-Dist: psutil>=5.8.0
Requires-Dist: bandit>=1.7.0
Requires-Dist: safety>=2.0.0
Requires-Dist: pylint>=2.12.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Hypertrial: Bitcoin DCA Strategy Framework

A Bitcoin Dollar-Cost Averaging (DCA) framework for evaluating and comparing algorithmic trading strategies.

## Installation

```bash
pip install hypertrial
```

## Quick Start

```python
import pandas as pd
from hypertrial import backtest_dynamic_dca, load_data, register_strategy

# Load Bitcoin data (included with the package)
btc_df = load_data()

# Create a simple custom strategy
@register_strategy("my_custom_strategy")
def custom_dca_strategy(df):
    # Strategy logic goes here
    # Return purchase weights for each day
    return weights_df

# Run backtest with your strategy
results = backtest_dynamic_dca(btc_df, strategy_name="my_custom_strategy")
```

## Key Features

- **DCA Strategy Testing**: Evaluate Bitcoin dollar-cost averaging strategies
- **Performance Metrics**: Analyze strategies using Sats Per Dollar (SPD)
- **Cross-Cycle Analysis**: Test strategies across multiple Bitcoin market cycles
- **Visualization Tools**: Plot performance metrics and strategy behaviors
- **Security Verification**: Security scanning for submitted strategies

## Command Line Interface

Hypertrial comes with a built-in CLI:

```bash
# List available strategies
hypertrial --list

# Run backtest with a specific strategy
hypertrial --strategy dynamic_dca

# Run backtest for all strategies
hypertrial --backtest-all --output-dir results
```

## Contributing

We welcome contributions! Please visit our [GitHub repository](https://github.com/mattfaltyn/hypertrial) for more information.

## License

This project is available under the MIT License.
