Metadata-Version: 2.4
Name: bquant
Version: 0.0.0
Summary: Quantitative research toolkit for financial markets
Author-email: kogriv <kogriv@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/kogriv/bquant
Project-URL: Documentation, https://bquant.readthedocs.io/
Project-URL: Repository, https://github.com/kogriv/bquant.git
Project-URL: Issues, https://github.com/kogriv/bquant/issues
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas==2.3.1
Requires-Dist: numpy==2.3.2
Requires-Dist: matplotlib==3.10.5
Requires-Dist: seaborn==0.13.2
Requires-Dist: pandas-ta==0.3.14b0
Requires-Dist: statsmodels==0.14.5
Requires-Dist: scipy==1.16.1
Requires-Dist: scikit-learn==1.7.1
Requires-Dist: plotly==6.3.0
Requires-Dist: kaleido==1.0.0
Requires-Dist: ipywidgets==8.1.7
Requires-Dist: psutil>=5.9.0
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=2.0; extra == "dev"
Requires-Dist: black>=21.0; extra == "dev"
Requires-Dist: flake8>=3.8; extra == "dev"
Provides-Extra: notebooks
Requires-Dist: jupyter==1.1.1; extra == "notebooks"
Requires-Dist: ipywidgets==8.1.7; extra == "notebooks"
Requires-Dist: plotly==6.3.0; extra == "notebooks"
Requires-Dist: kaleido==1.0.0; extra == "notebooks"
Provides-Extra: full
Requires-Dist: pytest>=6.0; extra == "full"
Requires-Dist: pytest-cov>=2.0; extra == "full"
Requires-Dist: black>=21.0; extra == "full"
Requires-Dist: flake8>=3.8; extra == "full"
Requires-Dist: jupyter==1.1.1; extra == "full"
Requires-Dist: ipywidgets==8.1.7; extra == "full"
Requires-Dist: plotly==6.3.0; extra == "full"
Requires-Dist: kaleido==1.0.0; extra == "full"
Dynamic: license-file

# BQuant - Quantitative Research Toolkit

**BQuant** is a universal toolkit for quantitative research of financial markets. The project starts with MACD zone analysis as the first use case, but the architecture is designed for exploring various aspects: technical indicators, chart patterns, candlestick formations, time series, and machine learning applications.

## 🔧 Key Features

- **Universal configuration system** - support for multiple data sources and brokers
- **Multi-level analysis** - technical, statistical, graphical, candlestick, time series
- **ML readiness** - structure for machine learning (stubs)
- **Visualization tools** - charts and reports
- **Research environment** - notebooks and experiments
- **Automated pipelines** - ready-to-use analysis scripts

## 🚀 Quick Start

### Installation

```bash
# Install in development mode
pip install -e .

# Install with optional dependencies
pip install -e .[dev,notebooks]
```

### Basic Usage

```python
from bquant.data import load_symbol_data
from bquant.indicators import MACDAnalyzer

# Load data
data = load_symbol_data('XAUUSD', '1h')

# Analyze MACD zones
analyzer = MACDAnalyzer(data, fast=8, slow=21)
zones = analyzer.identify_zones()

print(f"Found {len(zones)} zones")
```

### Command Line

```bash
# Analyze single instrument
bquant-analyze XAUUSD

# Batch analysis
bquant-batch EURUSD GBPUSD XAUUSD
```

## 📋 Project Structure

This is a monorepo that contains:

- **`bquant/`** - Python package (for PyPI)
- **`research/`** - Jupyter notebooks and experiments
- **`scripts/`** - Automation scripts
- **`data/`** - Data storage
- **`tests/`** - Test suite
- **`docs/`** - Documentation

## 🛠️ Development

### Setting up development environment

```bash
# Create virtual environment
python -m venv venv_bquant_dell

# Activate (Windows)
venv_bquant_dell\Scripts\activate

# Activate (Linux/Mac)
source venv_bquant_dell/bin/activate

# Install dependencies
pip install -r requirements.txt

# Install in development mode
pip install -e .[dev]
```

### Running tests

```bash
pytest tests/ -v
```

## 📚 Documentation

- [API Documentation](docs/api/)
- [Tutorials](docs/tutorials/)
- [Examples](docs/examples/)

## 🎯 Roadmap

- **Phase 1**: Core functionality (data, MACD analysis, statistics)
- **Phase 2**: Extended visualization, time series, other indicators
- **Phase 3**: Full ML, chart patterns, automation

## 📄 License

MIT License - see [LICENSE](LICENSE) file for details.

## 🤝 Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests.

## 📞 Contact

- **Author**: kogriv
- **Email**: kogriv@gmail.com
- **Repository**: https://github.com/kogriv/bquant
