Merge pull request #64 from xgboosted/feature-new-indicators

Feature new indicators

Author: xgboosted

CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 ## **[Unreleased]**
 
+### Added
+* **9 New Technical Indicators**: Added high-demand indicators from Issue #29 analysis:
+  - **LRSI** (Laguerre Relative Strength Index) - Momentum indicator with reduced lag using gamma parameter
+  - **PMAX** (Price Max) - Trend indicator combining moving average with ATR
+  - **VFI** (Volume Flow Indicator) - Money flow indicator analyzing volume direction
+  - **MMAR** (Madrid Moving Average Ribbon) - Multiple EMA ribbons for trend visualization
+  - **Rainbow** (Rainbow Charts) - Sequential SMA ribbons creating rainbow effect
+  - **PO** (Projection Oscillator) - Linear regression based momentum oscillator
+  - **DSP** (Detrended Synthetic Price) - Cycles indicator removing trend to reveal cycles
+  - **TRIXH** (TRIX Histogram) - Enhanced TRIX with signal line and histogram
+  - **VWMACD** (Volume Weighted MACD) - MACD variant using volume-weighted moving averages
+* **Full Indicator Name Comments**: All 150 indicator files now include full indicator names as comments on line 2 for improved code readability and documentation (format: `# Full Indicator Name (ABBREVIATION)`).
+
+### Changed
+* **Updated Indicator Counts**: Increased from 141 to 150 indicators (9 new additions), raising total count from 203 to 212 (150 indicators + 62 TA-Lib patterns).
+* **Enhanced RVGI**: Relative Vigor Index now includes histogram column (RVGI - Signal) in addition to RVGI and Signal columns.
+
 ### Fixed
 * **Code of Conduct Contact Information**: Updated enforcement contact from original maintainer's email to GitHub Issues link, making it maintainer-agnostic and easier to manage as the project evolves.
 * **PyPI Release Version**: Fixed CI/CD workflow to use exact release tag version by setting `SETUPTOOLS_SCM_PRETEND_VERSION` environment variable. This prevents development versions (`.dev0`) from being published when `pyproject.toml` is modified during the build process. Releases now correctly use the clean tag version (e.g., `0.3.35` instead of `0.3.36.dev0`).

README.md

@@ -20,7 +20,7 @@
 
 ![Example Chart](https://raw.githubusercontent.com/xgboosted/pandas-ta-classic/main/images/TA_Chart.png)
 
-**Pandas TA Classic** is an easy-to-use library that leverages the Pandas package with **141 indicators and utility functions** and **62 TA Lib candlestick patterns** (**203 total**). Many commonly used indicators are included, such as: _Simple Moving Average_ (**sma**), _Moving Average Convergence Divergence_ (**macd**), _Hull Exponential Moving Average_ (**hma**), _Bollinger Bands_ (**bbands**), _On-Balance Volume_ (**obv**), _Aroon & Aroon Oscillator_ (**aroon**), _Squeeze_ (**squeeze**) and **many more**.
+> **Pandas TA Classic** is an easy-to-use library that leverages the Pandas package with **150 indicators and utility functions** and **62 TA Lib candlestick patterns** (**212 total**). Many commonly used indicators are included, such as: _Simple Moving Average_ (**sma**), _Moving Average Convergence Divergence_ (**macd**), _Hull Exponential Moving Average_ (**hma**), _Bollinger Bands_ (**bbands**), _On-Balance Volume_ (**obv**), _Aroon & Aroon Oscillator_ (**aroon**), _Squeeze_ (**squeeze**) and **many more**.
 
 This is the **classic/community maintained version** of the popular pandas-ta library.
 
@@ -42,7 +42,7 @@ This is the **classic/community maintained version** of the popular pandas-ta li
 
 ### 🎯 Key Features
 
-- **203 Technical Indicators**: 141 indicators + 62 TA-Lib candlestick patterns
+- **212 Technical Indicators**: 150 indicators + 62 TA-Lib candlestick patterns
 - **Native Candlestick Patterns**: 5 patterns (cdl_doji, cdl_inside, cdl_z, cdl_pattern, ha) work without TA-Lib
 - **Automatic Versioning**: Version management via git tags using setuptools-scm
 - **Modern Package Management**: Full support for both `uv` and `pip`
@@ -132,9 +132,9 @@ df.ta.strategy("CommonStrategy")         # Runs commonly used indicators
 
 ## 📊 Features
 
-- **141 Technical Indicators & Utilities** across 9 categories (Candles, Momentum, Overlap, Trend, Volume, etc.)
+- **150 Technical Indicators & Utilities** across 9 categories (Candles, Momentum, Overlap, Trend, Volume, etc.)
 - **62 TA Lib Candlestick Patterns** for comprehensive pattern recognition
-- **203 Total Indicators & Patterns** - the most comprehensive Python TA library
+- **212 Total Indicators & Patterns** - the most comprehensive Python TA library
 - **Dynamic Category Discovery** - automatically detects all available indicators from the filesystem
 - **Strategy System** with multiprocessing support for bulk indicator processing
 - **Pandas DataFrame Extension** for seamless integration (`df.ta.indicator()`)
@@ -154,9 +154,9 @@ df.ta.strategy("CommonStrategy")         # Runs commonly used indicators
 - 📓 **[Examples](https://github.com/xgboosted/pandas-ta-classic/tree/main/examples)** - Jupyter notebooks with real examples
 
 **Reference Documentation:**
-- �📖 [**Usage Guide**](https://xgboosted.github.io/pandas-ta-classic/usage.html) - Programming conventions and basic usage
+- 📖 [**Usage Guide**](https://xgboosted.github.io/pandas-ta-classic/usage.html) - Programming conventions and basic usage
 - 🏗️ [**Strategy System**](https://xgboosted.github.io/pandas-ta-classic/strategies.html) - Multiprocessing and bulk indicator processing  
-- 📊 [**Indicators Reference**](https://xgboosted.github.io/pandas-ta-classic/indicators.html) - Complete list of all 141 indicators & 62 patterns
+- 📊 [**Indicators Reference**](https://xgboosted.github.io/pandas-ta-classic/indicators.html) - Complete list of all 150 indicators & 62 patterns
 - 🔧 [**DataFrame API**](https://xgboosted.github.io/pandas-ta-classic/dataframe_api.html) - Properties and methods reference
 - 📈 [**Performance Metrics**](https://xgboosted.github.io/pandas-ta-classic/performance.html) - Backtesting and performance analysis
 

docs/conf.py

@@ -12,9 +12,6 @@
 #
 # epub_uid = ''
 
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
-
 # -- Additional HTML configuration -------------------------------------------
 
 html_title = "Pandas TA Classic Documentation"
@@ -31,7 +28,7 @@
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = "%b %d, %Y"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -67,7 +64,8 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- Project information -----------------------------------------------------
 
@@ -78,6 +76,7 @@
 # Get version dynamically from the package
 try:
     from pandas_ta_classic._meta import __version__
+
     version = __version__
     release = __version__
 except ImportError:
@@ -96,7 +95,7 @@
 # ones.
 extensions = [
     "sphinx.ext.todo",
-    "sphinx.ext.mathjax", 
+    "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx_rtd_theme",
 ]
@@ -140,19 +139,19 @@
 # documentation.
 #
 html_theme_options = {
-    'canonical_url': '',
-    'analytics_id': '',
-    'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
-    'vcs_pageview_mode': '',
+    "canonical_url": "",
+    "analytics_id": "",
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "vcs_pageview_mode": "",
     # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/index.rst

@@ -1,7 +1,7 @@
 Pandas TA Classic Documentation
 ===============================
 
-**Pandas TA Classic** is an easy to use library that leverages the Pandas package with **141 indicators and utility functions** plus **62 TA-Lib candlestick patterns** (203 total). This is the **community maintained version** of the popular pandas-ta library.
+**Pandas TA Classic** is an easy to use library that leverages the Pandas package with **150 indicators and utility functions** plus **62 TA-Lib candlestick patterns** (212 total). This is the **community maintained version** of the popular pandas-ta library.
 
 .. note::
    The library features **dynamic configuration management**:

docs/indicators.rst

@@ -1,18 +1,18 @@
 Indicators Reference
 ===================
 
-**Pandas TA Classic** includes 141 indicators and utility functions plus 62 TA-Lib candlestick patterns (203 total) organized into the following categories:
+**Pandas TA Classic** includes 150 indicators and utility functions plus 62 TA-Lib candlestick patterns (212 total) organized into the following categories:
 
 * **Candles** (67) - Candlestick patterns for market sentiment analysis (5 native + 62 TA-Lib patterns)  
-* **Cycles** (1) - Cycle-based technical indicators  
-* **Momentum** (41) - Momentum and oscillator indicators
-* **Overlap** (34) - Moving averages and trend-following indicators
+* **Cycles** (2) - Cycle-based technical indicators  
+* **Momentum** (46) - Momentum and oscillator indicators
+* **Overlap** (36) - Moving averages and trend-following indicators
 * **Performance** (3) - Performance and return metrics
 * **Statistics** (10) - Statistical analysis functions
-* **Trend** (18) - Trend identification and direction indicators
+* **Trend** (19) - Trend identification and direction indicators
 * **Utility** (10) - Helper and utility functions
 * **Volatility** (14) - Volatility and range-based indicators
-* **Volume** (15) - Volume analysis indicators
+* **Volume** (16) - Volume analysis indicators
 
 .. note::
    The category system now uses **dynamic discovery** - indicators are automatically detected from the package structure, ensuring the list is always up-to-date with available indicators.
@@ -53,12 +53,13 @@ Available patterns:
 .. note::
    **Bold patterns** are native implementations. Use ``df.ta.cdl_doji()`` or ``df.ta.cdl_inside()`` to access the native doji and inside bar patterns directly.
 
-Cycles (1)
+Cycles (2)
 ----------
 
+* *Detrended Synthetic Price*: **dsp**
 * *Even Better Sinewave*: **ebsw**
 
-Momentum (41)
+Momentum (46)
 -------------
 
 Momentum and oscillator indicators for measuring the speed of price changes:
@@ -81,9 +82,11 @@ Momentum and oscillator indicators for measuring the speed of price changes:
 * *Inertia*: **inertia**
 * *KDJ*: **kdj**
 * *KST Oscillator*: **kst**
+* *Linear Regression RSI*: **lrsi**
 * *Moving Average Convergence Divergence*: **macd**
 * *Momentum*: **mom**
 * *Pretty Good Oscillator*: **pgo**
+* *Projection Oscillator*: **po**
 * *Percentage Price Oscillator*: **ppo**
 * *Psychological Line*: **psl**
 * *Percentage Volume Oscillator*: **pvo**
@@ -101,11 +104,13 @@ Momentum and oscillator indicators for measuring the speed of price changes:
 * *Stochastic RSI*: **stochrsi**
 * *TD Sequential*: **td_seq** (Excluded from ``df.ta.strategy()``)
 * *Trix*: **trix**
+* *TRIX Histogram*: **trixh**
 * *True strength index*: **tsi**
 * *Ultimate Oscillator*: **uo**
+* *Volume Weighted MACD*: **vwmacd**
 * *Williams %R*: **willr**
 
-Overlap (34)
+Overlap (36)
 ------------
 
 Moving averages and trend-following indicators:
@@ -124,11 +129,13 @@ Moving averages and trend-following indicators:
 * *Kaufman's Adaptive Moving Average*: **kama**
 * *Linear Regression*: **linreg**
 * *Moving Average*: **ma** (Generic moving average selector)
+* *Madrid Moving Average Ribbon*: **mmar**
 * *McGinley Dynamic*: **mcgd**
 * *Midpoint*: **midpoint**
 * *Midprice*: **midprice**
 * *Open-High-Low-Close Average*: **ohlc4**
 * *Pascal's Weighted Moving Average*: **pwma**
+* *Rainbow Moving Average*: **rainbow**
 * *WildeR's Moving Average*: **rma**
 * *Sine Weighted Moving Average*: **sinwma**
 * *Simple Moving Average*: **sma**
@@ -170,7 +177,7 @@ Statistical analysis functions:
 * *Variance*: **variance**
 * *Z Score*: **zscore**
 
-Trend (18)
+Trend (19)
 ----------
 
 Trend identification and direction indicators:
@@ -186,6 +193,7 @@ Trend identification and direction indicators:
 * *Increasing*: **increasing**
 * *Long Run*: **long_run**
 * *Parabolic Stop and Reverse*: **psar**
+* *Price Max*: **pmax**
 * *Q Stick*: **qstick**
 * *Short Run*: **short_run**
 * *Trend Signals*: **tsignals**
@@ -230,7 +238,7 @@ Volatility and range-based indicators:
 * *True Range*: **true_range**
 * *Ulcer Index*: **ui**
 
-Volume (15)
+Volume (16)
 -----------
 
 Volume analysis indicators:
@@ -249,4 +257,5 @@ Volume analysis indicators:
 * *Price-Volume*: **pvol**
 * *Price Volume Rank*: **pvr**
 * *Price Volume Trend*: **pvt**
+* *Volume Flow Indicator*: **vfi**
 * *Volume Profile*: **vp**

docs/quickstart.rst

@@ -304,7 +304,7 @@ Now that you've got the basics, explore more:
 
 1. **Tutorials** - Step-by-step guides in ``TUTORIALS.md``
 2. **Full Documentation** - Complete API reference at https://xgboosted.github.io/pandas-ta-classic/
-3. **Indicator Reference** - All 203 indicators
+3. **Indicator Reference** - All 212 indicators
 4. **Strategy Guide** - Advanced strategy system
 5. **Examples** - Jupyter notebooks with real examples
 

index.md

@@ -5,15 +5,15 @@ title: Pandas TA Classic - Technical Analysis Library
 
 # Pandas TA Classic
 
-**Pandas Technical Analysis (Pandas TA Classic)** is an easy to use library that leverages the Pandas package with **141 indicators and utility functions** plus **62 TA-Lib candlestick patterns** (**203 total**). This is the **community maintained version** of the popular pandas-ta library.
+**Pandas Technical Analysis (Pandas TA Classic)** is an easy to use library that leverages the Pandas package with **150 indicators and utility functions** plus **62 TA-Lib candlestick patterns** (**212 total**). This is the **community maintained version** of the popular pandas-ta library.
 
 ![Example Chart](https://raw.githubusercontent.com/xgboosted/pandas-ta-classic/main/images/TA_Chart.png)
 
 ## Features
 
-* **141 indicators and utility functions** across 9 categories
+* **150 indicators and utility functions** across 9 categories
 * **62 TA-Lib candlestick patterns** for comprehensive pattern recognition
-* **203 total indicators and patterns**
+* **212 total indicators and patterns**
 * Dynamic category discovery - automatically detects available indicators
 * Tightly correlated with TA-Lib indicators
 * Supports both standalone and DataFrame extension usage

pandas_ta_classic/candles/cdl_doji.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-from pandas_ta_classic.overlap import sma
+# Candle Doji (CDL_DOJI)
+from pandas_ta_classic.overlap.sma import sma
 from pandas_ta_classic.utils import get_offset, high_low_range, is_percent
 from pandas_ta_classic.utils import real_body, verify_series
 

pandas_ta_classic/candles/cdl_inside.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# Candle Inside (CDL_INSIDE)
 from pandas_ta_classic.utils import candle_color, get_offset
 from pandas_ta_classic.utils import verify_series
 

pandas_ta_classic/candles/cdl_pattern.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# Candle Pattern (CDL_PATTERN)
 from typing import Sequence, Union
 from pandas import Series, DataFrame