humbldata 1.23.0
open-sourcing the math behind major financial institutional investors/banks. this package connects financial data analysis to the humblFINANCE website.
Requires Python: <3.13,>=3.11

<p align="center">
  <img src="./docs/assets/temp_humbldata_logo.png" alt="Project logo" width="200px">
</p>

<h3 align="center">humblDATA</h3>

<div align="center">

  [![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/jjfantini/humbldata)
  [![Open in GitHub Codespaces](https://img.shields.io/static/v1?label=GitHub%20Codespaces&message=Open&color=blue&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=450509735)
  [![Status](https://img.shields.io/badge/status-active-success.svg)]()
  [![GitHub Issues](https://img.shields.io/github/issues/jjfantini/humbldata.svg)](https://github.com/jjfantini/humbldata/issues)
  [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/jjfantini/humbldata.svg)](https://github.com/jjfantini/humbldata/pulls)

  [![Python](https://img.shields.io/badge/Python-3.11.9-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
  [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
  [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
  [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brighgreen.svg)](http://commitizen.github.io/cz-cli/)
  <a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg" alt="Gitmoji"></a>
  <a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit" alt="pre-commit"></a>
  <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>


  ![License](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-black)

</div>

---
`humbldata` connects the humblfinance web app to its data sources and in-house analysis. A thin wrapper around the most popular open-source financial data providers, with some extra flair to use the same tools and math as the big guys. how do i know? because i used to pay a pretty penny for it! no longer... OSS is here to save the day!

# 🌟 Main Features 🌟

- **humblCHANNEL**
  - Quantitative trading signal tool that provides objective, mathematics-based buy and sell signals
  - Works with any tradable asset with available time series data
  - Customizable for different trading styles (day trading, swing trading, long-term investing)
  - Eliminates emotional decision-making with precise price channels

- **humblCOMPASS**
  - Economic regime identification and asset allocation guidance
  - Helps navigate different market conditions with data-driven insights
  - Provides strategic investment direction aligned with current market regimes

- **humblMOMENTUM**
  - Momentum-based signal indicators for timing market entries and exits
  - Track asset performance relative to market trends
  - Identify emerging opportunities before they become mainstream

- **humblPORTFOLIO**
  - Interactive portfolio management dashboard
  - Integrates data from humblCHANNEL and humblCOMPASS
  - Provides real-time asset overview with buy/sell recommendations
  - Risk management tools to prevent significant drawdowns

- **Realized Volatility Estimators**
  - All volatility calculations from Euan Sinclair's book, plus additional models
  - ⚡ Lightning fast estimators powered by Rust under the hood
  - Essential for accurate risk assessment and position sizing

# Getting Started

Install with `pip`:
```bash
pip install humbldata
```
Install with `poetry`:
```bash
poetry add humbldata
```

Install with `uv`:
```bash
uv add humbldata
```

## Documentation

For complete documentation on the library's features, architecture, and how to contribute, please visit:
[https://humblfinance.github.io/humblDATA/](https://humblfinance.github.io/humblDATA/)