nautilus_indicators/python/
mod.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Python bindings from [PyO3](https://pyo3.rs).
17
18#![expect(
19    clippy::missing_errors_doc,
20    reason = "errors documented on underlying Rust methods"
21)]
22#![allow(
23    clippy::unused_self,
24    reason = "PyO3 stub methods take &self for Python API parity even when the body is empty"
25)]
26
27pub mod average;
28pub mod book;
29pub mod momentum;
30pub mod ratio;
31pub mod volatility;
32
33use pyo3::{prelude::*, pymodule};
34
35/// Initializes the Python `indicators` module by adding all indicator classes.
36///
37/// # Errors
38///
39/// Returns a Python exception if adding any indicator class fails.
40#[pymodule]
41pub fn indicators(_: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
42    // Average
43    m.add_class::<crate::average::MovingAverageType>()?;
44    m.add_class::<crate::average::ema::ExponentialMovingAverage>()?;
45    m.add_class::<crate::average::sma::SimpleMovingAverage>()?;
46    m.add_class::<crate::average::ama::AdaptiveMovingAverage>()?;
47    m.add_class::<crate::average::dema::DoubleExponentialMovingAverage>()?;
48    m.add_class::<crate::average::hma::HullMovingAverage>()?;
49    m.add_class::<crate::average::rma::WilderMovingAverage>()?;
50    m.add_class::<crate::average::vidya::VariableIndexDynamicAverage>()?;
51    m.add_class::<crate::average::vwap::VolumeWeightedAveragePrice>()?;
52    m.add_class::<crate::average::lr::LinearRegression>()?;
53    m.add_class::<crate::average::wma::WeightedMovingAverage>()?;
54    m.add_class::<crate::average::zscore::ZScore>()?;
55
56    // Book
57    m.add_class::<crate::book::imbalance::BookImbalanceRatio>()?;
58
59    // Ratio
60    m.add_class::<crate::ratio::efficiency_ratio::EfficiencyRatio>()?;
61    m.add_class::<crate::ratio::spread_analyzer::SpreadAnalyzer>()?;
62
63    // Momentum
64    m.add_class::<crate::momentum::rsi::RelativeStrengthIndex>()?;
65    m.add_class::<crate::momentum::aroon::AroonOscillator>()?;
66    m.add_class::<crate::momentum::bias::Bias>()?;
67    m.add_class::<crate::momentum::cmo::ChandeMomentumOscillator>()?;
68    m.add_class::<crate::momentum::vhf::VerticalHorizontalFilter>()?;
69    m.add_class::<crate::momentum::kvo::KlingerVolumeOscillator>()?;
70    m.add_class::<crate::momentum::dm::DirectionalMovement>()?;
71    m.add_class::<crate::momentum::ichimoku::IchimokuCloud>()?;
72    m.add_class::<crate::momentum::amat::ArcherMovingAveragesTrends>()?;
73    m.add_class::<crate::momentum::swings::Swings>()?;
74    m.add_class::<crate::momentum::bb::BollingerBands>()?;
75    m.add_class::<crate::momentum::stochastics::StochasticsDMethod>()?;
76    m.add_class::<crate::momentum::stochastics::Stochastics>()?;
77    m.add_class::<crate::momentum::psl::PsychologicalLine>()?;
78    m.add_class::<crate::momentum::pressure::Pressure>()?;
79    m.add_class::<crate::momentum::cci::CommodityChannelIndex>()?;
80    m.add_class::<crate::momentum::roc::RateOfChange>()?;
81    m.add_class::<crate::momentum::macd::MovingAverageConvergenceDivergence>()?;
82    m.add_class::<crate::momentum::obv::OnBalanceVolume>()?;
83
84    // Volatility
85    m.add_class::<crate::volatility::atr::AverageTrueRange>()?;
86    m.add_class::<crate::volatility::vr::VolatilityRatio>()?;
87    m.add_class::<crate::volatility::dc::DonchianChannel>()?;
88    m.add_class::<crate::volatility::rvi::RelativeVolatilityIndex>()?;
89    m.add_class::<crate::volatility::kc::KeltnerChannel>()?;
90    m.add_class::<crate::volatility::fuzzy::CandleBodySize>()?;
91    m.add_class::<crate::volatility::fuzzy::CandleDirection>()?;
92    m.add_class::<crate::volatility::fuzzy::CandleSize>()?;
93    m.add_class::<crate::volatility::fuzzy::CandleWickSize>()?;
94    m.add_class::<crate::volatility::fuzzy::FuzzyCandle>()?;
95    m.add_class::<crate::volatility::fuzzy::FuzzyCandlesticks>()?;
96    m.add_class::<crate::volatility::kp::KeltnerPosition>()?;
97    Ok(())
98}
nautilus_indicators/python/mod.rs

nautilus_indicators/python/
mod.rs
