centaur_technical_indicators 1.0.1__tar.gz

centaur_technical_indicators-1.0.1/.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @chironmind

centaur_technical_indicators-1.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

centaur_technical_indicators-1.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

centaur_technical_indicators-1.0.1/.github/copilot-instructions.md

@@ -0,0 +1,185 @@
+# Copilot Instructions for Centaur Technical Indicators
+
+## Repository Overview
+
+**Centaur Technical Indicators** is a production-ready Python library providing 60+ technical indicators for financial analysis, built on a high-performance Rust backend. The project uses PyO3 and maturin to create Python bindings for the underlying Rust implementation.
+
+**Key Stats:**
+- **Languages:** Rust (backend), Python (bindings/tests)  
+- **Build System:** maturin (Rust-Python integration)
+- **Python Support:** 3.10+ (tested through 3.14)
+- **Test Suite:** 107 tests, ~0.31s runtime
+- **License:** MIT
+
+## Build Instructions & Validated Commands
+
+### Bootstrap & Environment Setup (Required)
+**Always create a virtual environment before building:**
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+```
+
+### Install Dependencies (Required)
+```bash
+pip install -r test_requirements.txt
+```
+**Contents:** maturin==1.9.1, pytest==8.4.1, and supporting packages
+
+### Build the Project (Required)
+```bash
+maturin develop
+```
+- **Duration:** ~14 seconds for full compilation
+- **Function:** Compiles Rust code and installs Python package in editable mode
+- **Output:** Installs `centaur_technical_indicators` package locally
+
+### Run Tests (Validation)
+```bash
+python -m pytest
+```
+- **Expected:** 107 tests pass in ~0.31s
+- **Coverage:** All indicator modules with bulk/single function variants
+
+### Format Code (Optional)
+```bash
+cargo fmt --check  # Check Rust formatting
+```
+
+### Environment Versions (Reference)
+- **Python:** 3.12.3+ 
+- **Rust:** 1.89.0+
+- **maturin:** 1.9.1
+
+## Project Layout & Architecture
+
+### Root Directory Structure
+```
+/
+├── .github/           # Workflows, issue templates, CODEOWNERS
+├── src/              # Rust source modules
+├── tests/            # Python test files (mirror src/ structure)
+├── assets/           # Documentation assets, banner images
+├── pyproject.toml    # Python project configuration, maturin settings
+├── Cargo.toml        # Rust project configuration, dependencies
+├── requirements.txt  # Runtime dependencies (minimal)
+├── test_requirements.txt  # Development/test dependencies
+└── README.md         # Comprehensive project documentation
+```
+
+### Source Code Architecture (`src/`)
+**Modular Design by Analysis Area:**
+- `lib.rs` - Main module, PyO3 bindings setup, type definitions
+- `candle_indicators.rs` - Ichimoku, Bollinger Bands, Keltner, Supertrend
+- `momentum_indicators.rs` - RSI, MACD, CCI, Williams %R, Stochastic
+- `moving_average.rs` - Simple, Exponential, Smoothed, McGinley Dynamic
+- `standard_indicators.rs` - Basic indicators, moving averages
+- `trend_indicators.rs` - Aroon, Parabolic SAR, DM, TSI
+- `volatility_indicators.rs` - Ulcer Index, Volatility System
+- `strength_indicators.rs` - A/D, PVI, NVI, RVI
+- `chart_trends.rs` - Trend analysis, peak/valley detection
+- `correlation_indicators.rs` - Asset price correlation
+- `other_indicators.rs` - ROI, True Range, ATR
+
+### API Design Patterns
+- **Dual Function Variants:** Each indicator has `bulk` (returns list) and `single` (returns scalar) versions
+- **Type System:** Custom enums (`PyConstantModelType`, `DeviationModel`, `MovingAverageType`) for configuration
+- **Error Handling:** Uses `PyValueError` for invalid inputs with descriptive messages
+
+### Test Structure (`tests/`)
+- **Naming Convention:** `test_<module_name>.py` mirrors `src/<module_name>.rs`
+- **Purpose:** Binding verification, not exhaustive testing (core logic tested in RustTI)
+- **Pattern:** Basic smoke tests to ensure Python-Rust interface works
+
+## CI/CD & Validation Pipelines
+
+### GitHub Workflows
+1. **`python-package.yml`** - Pull request validation
+   - Tests across Python 3.10-3.14 on Ubuntu
+   - Steps: checkout → setup Python → install deps → maturin develop → pytest
+
+2. **`CI.yml`** - Release pipeline (maturin-generated)
+   - Multi-platform wheel building (Linux, Windows, macOS)
+   - Multiple architectures (x86_64, ARM, etc.)
+   - Automatic PyPI publication on tags
+
+### Pre-commit Validation Steps
+```bash
+# Recommended validation sequence:
+source .venv/bin/activate
+pip install -r test_requirements.txt
+maturin develop
+python -m pytest
+cargo fmt --check  # Optional: check Rust formatting
+```
+
+## Development Guidelines
+
+### Making Code Changes
+1. **Rust Changes:** Edit files in `src/`, then run `maturin develop` to rebuild
+2. **Python Tests:** Add corresponding tests in `tests/` following existing patterns
+3. **API Consistency:** Maintain `bulk`/`single` function variants for new indicators
+4. **Type Safety:** Use existing enum types or add new ones following the pattern in `lib.rs`
+
+### Performance Considerations
+- **Rust Backend:** Core calculations optimized for microsecond-level performance
+- **Bulk vs Single:** Use `bulk` for time series, `single` for latest values
+- **Memory:** Rust handles memory management; Python side is minimal overhead
+
+### Dependencies & Updates
+- **Rust Dependencies:** Managed in `Cargo.toml` (pyo3, rust_ti)
+- **Python Dependencies:** Keep `test_requirements.txt` minimal
+- **Version Constraints:** Python 3.10+ required for modern features
+
+## Common Workflows & Commands
+
+### Complete Development Setup
+```bash
+git clone <repo>
+cd CentaurTechnicalIndicators-Python
+python -m venv .venv
+source .venv/bin/activate
+pip install -r test_requirements.txt
+maturin develop
+python -m pytest
+```
+
+### Iterative Development
+```bash
+# After making Rust changes:
+maturin develop  # Rebuild and reinstall
+python -m pytest  # Verify no regressions
+
+# After making Python test changes:
+python -m pytest  # Run updated tests
+```
+
+### Release Preparation
+```bash
+cargo fmt  # Format Rust code
+python -m pytest  # Ensure all tests pass
+# CI handles wheel building and PyPI publication
+```
+
+## Key Files & Configuration
+
+### Build Configuration
+- **`pyproject.toml`:** Python packaging, maturin settings, project metadata
+- **`Cargo.toml`:** Rust compilation, dependencies (pyo3, rust_ti)
+- **`.gitignore`:** Excludes `target/`, `.venv/`, `__pycache__/`, build artifacts
+
+### Documentation Resources
+- **`README.md`:** Complete user documentation, examples, API reference
+- **`CONTRIBUTING.md`:** Contribution guidelines, new indicator process
+- **Wiki:** Full API reference and usage examples
+- **External:** Tutorials, benchmarks, and how-to guides in separate repos
+
+## Trust These Instructions
+
+These instructions are validated and complete. Only perform additional repository exploration if:
+- The build process fails unexpectedly
+- Dependencies have changed significantly
+- New requirements are introduced in documentation
+
+The provided build sequence works reliably and efficiently for the current codebase.

centaur_technical_indicators-1.0.1/.github/workflows/CI.yml

@@ -0,0 +1,183 @@
+# This file is autogenerated by maturin v1.11.5
+# To update, run
+#
+#    maturin generate-ci github
+#
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-22.04
+            target: x86_64
+          - runner: ubuntu-22.04
+            target: x86
+          - runner: ubuntu-22.04
+            target: aarch64
+          - runner: ubuntu-22.04
+            target: armv7
+          - runner: ubuntu-22.04
+            target: s390x
+          - runner: ubuntu-22.04
+            target: ppc64le
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v5
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+  musllinux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-22.04
+            target: x86_64
+          - runner: ubuntu-22.04
+            target: x86
+          - runner: ubuntu-22.04
+            target: aarch64
+          - runner: ubuntu-22.04
+            target: armv7
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+          manylinux: musllinux_1_2
+      - name: Upload wheels
+        uses: actions/upload-artifact@v5
+        with:
+          name: wheels-musllinux-${{ matrix.platform.target }}
+          path: dist
+
+  windows:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: windows-latest
+            target: x64
+            python_arch: x64
+          - runner: windows-latest
+            target: x86
+            python_arch: x86
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+          architecture: ${{ matrix.platform.python_arch }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Upload wheels
+        uses: actions/upload-artifact@v5
+        with:
+          name: wheels-windows-${{ matrix.platform.target }}
+          path: dist
+
+  macos:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: macos-15-intel
+            target: x86_64
+          - runner: macos-latest
+            target: aarch64
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: 3.x
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
+      - name: Upload wheels
+        uses: actions/upload-artifact@v5
+        with:
+          name: wheels-macos-${{ matrix.platform.target }}
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v5
+        with:
+          name: wheels-sdist
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
+    needs: [linux, musllinux, windows, macos, sdist]
+    permissions:
+      # Use to sign the release artifacts
+      id-token: write
+      # Used to upload release artifacts
+      contents: write
+      # Used to generate artifact attestation
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@v6
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v3
+        with:
+          subject-path: 'wheels-*/*'
+      - name: Install uv
+        if: ${{ startsWith(github.ref, 'refs/tags/') }}
+        uses: astral-sh/setup-uv@v7
+      - name: Publish to PyPI
+        if: ${{ startsWith(github.ref, 'refs/tags/') }}
+        run: uv publish 'wheels-*/*'
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

centaur_technical_indicators-1.0.1/.github/workflows/python-package.yml

@@ -0,0 +1,28 @@
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Test with PyTest
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv .venv
+          source .venv/bin/activate
+          pip install -r test_requirements.txt
+          maturin develop
+          python -m pytest

centaur_technical_indicators-1.0.1/.gitignore

@@ -0,0 +1,134 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDE
+.idea/
+.vscode/
+venv

centaur_technical_indicators-1.0.1/CHANGELOG.md

@@ -0,0 +1,86 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [1.0.0] - 2026-01-19
+
+### Changed
+- **Breaking:** Rebranded from PyTechnicalIndicators to CentaurTechnicalIndicators-Python
+  - Updated all documentation, README, and links to reflect the new CentaurTechnicalIndicators branding
+  - Updated package metadata to reflect the new name and branding
+
+---
+
+*** /!\ The release notes below cover the PyTechnicalIndicators packages before the rebranding /!\ ***
+
+## [3.0.5] - 2025-10-19
+
+### Changed
+- Updated rust_ti dependency from 2.1.5 to 2.2.0
+
+### Added
+- Added support for new probability distribution deviation models from rust_ti 2.2.0:
+	- `LogStandardDeviation` - Log-scale standard deviation for analyzing log-returns
+	- `LaplaceStdEquivalent` - Laplace (double exponential) distribution scaled to standard deviation
+	- `CauchyIQRScale` - Cauchy distribution scaled by interquartile range for extreme outliers
+- Added string aliases for new deviation models: `"log"`, `"logstd"`, `"laplace"`, `"cauchy"`
+- Enhanced `PyDeviationModel::from_string()` to support the new deviation models
+
+### Fixed
+- Updated test expectations for median and mode absolute deviation calculations due to improved algorithms in rust_ti 2.2.0
+
+---
+
+## [3.0.4] - 2025-10-08
+
+### Changed
+- Updated rust_ti dependency from 2.1.4 to 2.1.5
+	- Updated `break_down_trends` function to use new `TrendBreakConfig` struct from rust_ti 2.1.5
+	- Updated parameter names in `break_down_trends`
+
+---
+
+## [3.0.3] - 2025-08-13
+
+### Added
+- Updated README.md to add links to How-Tos, a summary of benchmarks, and a badge linking to Read the Docs.
+
+---
+
+## [3.0.2] - 2025-08-07
+
+### Changed
+- Minor document updates
+- Updated RustTI version to include volatilty system fix
+
+### Added
+- Better badges to README
+
+---
+
+## [3.0.1] - 2025-08-04
+
+### Changed
+- Updated the package version number...
+
+---
+
+## [3.0.0] - 2025-08-04
+
+### Added
+- Added bindings using PyO3 and Maturin
+
+### Changed
+- Major changes to all functions, they are now bindings for the same functions in RustTI
+
+### Removed
+- Pure python functionality
+
+---
+
+Older releases aren't tracked in this file but some information can be found [here](https://github.com/chironmind/PyTechnicalIndicators/releases)
+