Metadata-Version: 2.4
Name: wqbkit
Version: 0.2.2
Summary: WorldQuant Brain Alpha Research Automation Toolkit
Project-URL: Homepage, https://github.com/Crotes/wqbkit
Project-URL: Issues, https://github.com/Crotes/wqbkit/issues
Author-email: Crotes <Crotes@yeah.net>
License: MIT
Keywords: alpha,finance,quantitative,research,trading,worldquant
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.10
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: psycopg2-binary
Requires-Dist: python-dotenv
Requires-Dist: pytz
Requires-Dist: requests
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: sqlalchemy>=2.0
Requires-Dist: tqdm
Requires-Dist: wqb
Provides-Extra: dev
Requires-Dist: jupyter; extra == 'dev'
Requires-Dist: matplotlib; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Description-Content-Type: text/markdown

# wqb-toolkit

WorldQuant Brain Alpha Research Automation Toolkit

## Overview

`wqb-toolkit` is a Python toolkit for automating alpha research workflows on the WorldQuant Brain (WQB) platform. It provides core infrastructure for:

- **Alpha Simulation**: Multi-threaded batch simulation with queue-based result handling
- **Alpha Machine**: Genetic iteration pipeline for alpha expression evolution
- **Correlation Analysis**: Self, PPAC, prod, and self_web correlation calculations
- **Database Management**: PostgreSQL ORM with SQLAlchemy for alpha metadata and PnL caching
- **Super Alpha Tools**: Construction and simulation of SUPER-type alphas

## Installation

```bash
pip install wqb-toolkit
```

### Prerequisites

- Python >= 3.10
- PostgreSQL (for database features)
- `wqb` SDK (WorldQuant Brain official SDK, install via pip)

## Quick Start

```python
from wqbkit.app.core.alpha_db_core import AlphaDbCore
from wqbkit.modules.correlation import AlphaCalcCorr

core = AlphaDbCore()
calcor = AlphaCalcCorr()
```

## Configuration

Create a `.env` file in your project root:

```env
DB_HOST=localhost
DB_PORT=5432
DB_NAME=WorldQuant
DB_USER=your_db_user
DB_PASSWORD=your_db_password
WQB_USERNAME=your_wqb_username
WQB_PASSWORD=your_wqb_password
WQB_API_BASE_URL=https://www.worldquantbrain.com
```

## License

MIT
