centaur_technical_indicators 1.2.0__tar.gz → 1.2.1__tar.gz

centaur_technical_indicators-1.2.1/.github/pull_request_template.md

@@ -0,0 +1,28 @@
+## Summary
+- What changed?
+- Why was this change needed?
+
+## Scope
+- Files/modules touched:
+- Intentionally not changed:
+
+## Compatibility
+- User-facing Python API impact:
+- Migration notes (if any):
+
+## Validation
+- [ ] `maturin develop` (bindings compile cleanly)
+- [ ] `python -m pytest` (all tests pass)
+- [ ] `cargo fmt --check` (no formatting diffs)
+
+Command output summary:
+
+## Changelog
+- [ ] `CHANGELOG.md` updated for user-facing changes
+- Entry summary:
+
+## Manual Verification
+- What was manually verified?
+
+## AI Assistance Disclosure
+- Was AI used? If yes, summarize what AI changed and what you verified manually.

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/AGENTS.md

@@ -9,6 +9,13 @@ Guidance for coding agents working in this repository.
   - `src/` → Rust implementation + Python bindings
   - `tests/` → Python-facing smoke/behavior tests for bindings
 
+## Docs to review before coding
+- `docs/AI_ONBOARDING.md`
+- `.github/copilot-instructions.md`
+- `AI_FRIENDLY_ROADMAP.md`
+- `docs/REPO_MAP.md`
+- `CONTRIBUTING.md`
+
 ## Recommended workflow
 1. **Set up an isolated environment**
    ```bash
@@ -42,6 +49,30 @@ Guidance for coding agents working in this repository.
 - Keep naming and argument conventions consistent with neighboring functions.
 - Use clear, user-facing error messages for invalid inputs.
 
+## Change scope discipline
+- Keep changes minimal and focused on the requested task.
+- Do not include opportunistic refactors unless explicitly requested.
+- If you identify unrelated issues, note them separately instead of bundling them into the same change.
+- Preserve existing file organization and naming conventions unless the task requires a structural change.
+
+## Backward compatibility rules
+When changing public Python APIs, preserve compatibility unless the task explicitly allows a breaking change:
+
+1. Do not silently change indicator semantics, output ordering, or warmup behavior.
+2. Do not remove or rename public functions, types, enums, or parameters without explicit approval.
+3. If behavior changes are required, document them in docstrings and `CHANGELOG.md` with clear migration notes.
+
+## Pre-PR quality gates (must pass)
+Run these before opening a PR:
+
+1. `maturin develop` (bindings compile cleanly)
+2. `python -m pytest` (all tests pass)
+3. `cargo fmt --check` (no formatting diffs)
+
+## CI implementation policy
+- Prefer native Python/maturin/cargo commands in workflows.
+- Do not introduce third-party GitHub Actions unless explicitly approved by maintainers.
+
 ## Validation expectations before finishing
 - Rebuild bindings after Rust changes: `maturin develop`.
 - Run relevant tests (ideally full `python -m pytest`).
@@ -54,8 +85,23 @@ Guidance for coding agents working in this repository.
 - [ ] Documentation/changelog updated when needed.
 - [ ] Commit message clearly describes the change.
 
+## PR expectations for agents
+- Keep PRs focused and minimal.
+- Summarize what the agent changed and what was manually verified.
+- Include command output summary for the required quality gates.
+- Explicitly note the `CHANGELOG.md` entry.
+
+### Required PR summary format
+Use this structure in PR descriptions/comments:
+
+1. `Summary`: what changed and why.
+2. `Scope`: files/modules touched and what was intentionally not changed.
+3. `Compatibility`: any user-facing behavior/API impact.
+4. `Validation`: results summary for `maturin develop`, `pytest`, and `cargo fmt`.
+5. `Changelog`: exact `CHANGELOG.md` entry added/updated.
+
 ## Repository expectations
-- This is a public Rust library. Prioritize correctness, determinism, and backward compatibility.
+- This is a public Python/Rust library. Prioritize correctness, determinism, and backward compatibility.
 - Prefer minimal, focused diffs over broad refactors.
 - Do not add new dependencies unless explicitly requested.
 - Treat public APIs, documented behavior, and examples as stability-sensitive.
@@ -69,3 +115,4 @@ Guidance for coding agents working in this repository.
 ## Change boundaries
 - Do not modify CI, licensing, security, or contributor-governance files unless explicitly requested.
 - Keep unrelated formatting churn to a minimum.
+

centaur_technical_indicators-1.2.1/AI_FRIENDLY_ROADMAP.md

@@ -0,0 +1,90 @@
+# AI-Friendly Roadmap
+
+This document is a practical map for contributors and coding agents working in `CentaurTechnicalIndicators-Python`.
+
+## How to use this roadmap
+
+- `Now`: high-confidence, near-term items that improve contributor and agent reliability.
+- `Next`: medium-term items that build on completed `Now` work.
+- `Later`: directional items that should not block current PRs.
+- Each milestone includes acceptance criteria and non-goals to keep the implementation scope clear.
+
+## Current API surface by module
+
+This package exposes Python bindings for the following indicator modules from the upstream Rust crate, each with `single` and/or `bulk` submodules where applicable:
+
+- `candle_indicators`: candle-derived indicators (bands/channels/envelopes and related tools).
+- `chart_trends`: peak/valley and trend-structure analysis.
+- `correlation_indicators`: pairwise/statistical relationship indicators.
+- `momentum_indicators`: momentum and oscillator families.
+- `moving_average`: core moving-average implementations.
+- `other_indicators`: miscellaneous indicators.
+- `strength_indicators`: strength/volume participation indicators.
+- `trend_indicators`: trend direction/strength systems.
+- `volatility_indicators`: volatility and range-expansion indicators.
+
+Shared Python-side support:
+
+- `lib.rs`: PyO3 module wiring, shared type enum definitions.
+- `PyConstantModelType`, `DeviationModel`, `MovingAverageType`: shared enums passed as strings from Python.
+
+## Binding design conventions
+
+1. **Preserve the bulk/single API pattern** — each indicator exposes a `bulk` (returns list) and `single` (returns scalar) variant.
+2. **Accept enum arguments as strings** — all model/type parameters are accepted as Python strings and resolved in Rust with user-friendly error messages on invalid input.
+3. **Use `PyValueError`** for all user-facing error surfaces at the Python boundary.
+4. **Do not silently change indicator semantics** — bindings delegate all calculation logic to the upstream Rust crate.
+
+## Testing/validation expectations
+
+Before opening a PR, contributors should run and report:
+
+1. `maturin develop` (bindings compile cleanly)
+2. `python -m pytest` (all tests pass)
+3. `cargo fmt --check` (no formatting diffs)
+
+## Contributor workflow roadmap
+
+This section tracks changes that make the repository easier for both human contributors and coding agents to work in safely.
+
+### Now
+
+1. **PR quality report standardization**
+   - Goal: all AI/human PRs present the same validation summary shape.
+   - Acceptance criteria:
+     - `AGENTS.md` defines a required PR summary format.
+     - PR descriptions consistently include `Summary`, `Scope`, `Compatibility`, `Validation`, and `Changelog`.
+   - Non-goals:
+     - Enforcing via CI in this milestone.
+2. **Repository orientation map**
+   - Goal: reduce onboarding/search time for contributors and agents.
+   - Acceptance criteria:
+     - `docs/REPO_MAP.md` exists with key directories, extension points, and "if changing X, also check Y" guidance.
+   - Non-goals:
+     - Exhaustive architecture documentation.
+3. **Machine-readable contribution policy**
+   - Goal: enable deterministic checks by automation/bots.
+   - Acceptance criteria:
+     - `ai-policy.yaml` lists required checks and user-facing change obligations.
+     - Policy contents match `AGENTS.md`/`CONTRIBUTING.md`.
+   - Non-goals:
+     - Full custom policy engine implementation.
+
+### Next
+
+1. **CI guardrails for contribution policy**
+   - Goal: make contributor requirements executable rather than advisory.
+   - Acceptance criteria:
+     - CI checks for required validation commands.
+     - CI checks for `CHANGELOG.md` updates on user-facing changes.
+   - Non-goals:
+     - Blocking on benchmark jobs in the main CI pipeline.
+
+### Later
+
+1. **Agent bootstrap command**
+   - Goal: provide a one-command local setup and verification flow for new contributors/agents.
+   - Acceptance criteria:
+     - Script or task runner target that documents and runs core checks in order.
+   - Non-goals:
+     - Replacing existing contributor docs.

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/CHANGELOG.md

@@ -6,6 +6,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ---
 
+## [1.2.1] - 2026-03-01
+
+### Changed
+- Updated `centaur_technical_indicators` Rust crate dependency from `1.2.0` to `1.2.1`
+  - Removed `#[allow(deprecated)]` from `volume_price_trend` binding functions (`src/trend_indicators.rs`) as the upstream crate removed the deprecation marker in `1.2.1`
+
+### Added
+- Added `AI_FRIENDLY_ROADMAP.md` with module API surface, contributor-workflow, and library-feature roadmap adapted for this Python binding repository
+- Added `docs/AI_ONBOARDING.md` as canonical start-here onboarding flow for coding agents
+- Added `docs/REPO_MAP.md` with a quick repository map, extension points, and "if changing X, also check Y" guidance
+- Added machine-readable repository policy file `ai-policy.yaml` for required checks, change obligations, and PR section requirements
+- Added default pull request template at `.github/pull_request_template.md` with required sections (`Summary`, `Scope`, `Compatibility`, `Validation`, `Changelog`)
+- Expanded `AGENTS.md` with change-scope discipline, backward compatibility rules, pre-PR quality gates, CI implementation policy, and required PR summary format
+- Updated `CONTRIBUTING.md` with local quality gates and AI-assisted contribution checklist
+
+---
+
 ## [1.2.0] - 2026-02-26
 
 ### Changed

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/CONTRIBUTING.md

@@ -51,5 +51,28 @@ See [open issues](https://github.com/ChironMind/CentaurTechnicalIndicators-Pytho
 
 ---
 
+## 🔒 Local quality gates
+
+Run these before opening a PR:
+
+1. `maturin develop` — bindings compile cleanly
+2. `python -m pytest` — all tests pass
+3. `cargo fmt --check` — no formatting diffs
+
+---
+
+## 🤖 AI-assisted contribution checklist
+
+If you used an AI agent to contribute:
+
+- [ ] Reviewed all AI-generated changes for correctness
+- [ ] Confirmed the scope is minimal and matches the task
+- [ ] Verified `maturin develop` builds successfully
+- [ ] Verified `python -m pytest` passes
+- [ ] Updated `CHANGELOG.md` with a user-facing entry
+- [ ] Disclosed AI assistance in the PR description
+
+---
+
 Thanks again for your interest and contributions!
 

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/Cargo.lock

@@ -10,17 +10,17 @@ checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8"
 
 [[package]]
 name = "centaur_technical_indicators"
-version = "1.2.0"
+version = "1.2.1"
 dependencies = [
- "centaur_technical_indicators 1.2.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "centaur_technical_indicators 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "pyo3",
 ]
 
 [[package]]
 name = "centaur_technical_indicators"
-version = "1.2.0"
+version = "1.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e1a34ab4d40a88bc6253ca7096ef88556ff5b128747ef47ee914b576e7270035"
+checksum = "63ef54b5d445d6f4c8b4e6971f57caa886556467112b283ff8ca1af16f6a8c90"
 
 [[package]]
 name = "heck"

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "centaur_technical_indicators"
-version = "1.2.0"
+version = "1.2.1"
 edition = "2021"
 readme = "README.md"
 
@@ -11,4 +11,4 @@ crate-type = ["cdylib"]
 
 [dependencies]
 pyo3 = "0.25.0"
-centaur_technical_indicators = "1.2.0"
+centaur_technical_indicators = "1.2.1"

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: centaur_technical_indicators
-Version: 1.2.0
+Version: 1.2.1
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Topic :: Software Development :: Libraries

centaur_technical_indicators-1.2.1/ai-policy.yaml

@@ -0,0 +1,52 @@
+version: 1
+repository: CentaurTechnicalIndicators-Python
+
+required_checks:
+  local_commands:
+    - maturin develop
+    - python -m pytest
+    - cargo fmt --check
+  benchmark:
+    required_for_paths:
+      - src/candle_indicators.rs
+      - src/chart_trends.rs
+      - src/correlation_indicators.rs
+      - src/momentum_indicators.rs
+      - src/moving_average.rs
+      - src/other_indicators.rs
+      - src/strength_indicators.rs
+      - src/trend_indicators.rs
+      - src/volatility_indicators.rs
+    companion_repo: https://github.com/ChironMind/CentaurTechnicalIndicators-benchmarks
+
+change_requirements:
+  user_facing_change_requires:
+    - CHANGELOG.md
+  public_api_change_requires:
+    - Rust docstring updates for changed/new public binding functions
+    - tests in matching tests/ module
+    - PR Compatibility section summarizing API impact
+
+coding_rules:
+  api_pattern:
+    instruction: Preserve the bulk/single function variant pattern for all indicators.
+  errors:
+    required_error_type: PyValueError
+    instruction: Surface all errors to Python as PyValueError with user-meaningful messages.
+  compatibility:
+    preserve_public_api_unless_explicit_breaking_approval: true
+
+pr_report:
+  required_sections:
+    - Summary
+    - Scope
+    - Compatibility
+    - Validation
+    - Changelog
+
+notes:
+  source_of_truth:
+    - AGENTS.md
+    - CONTRIBUTING.md
+    - AI_FRIENDLY_ROADMAP.md
+  purpose: Minimal machine-readable policy for AI agents and automation.

centaur_technical_indicators-1.2.1/docs/AI_ONBOARDING.md

@@ -0,0 +1,64 @@
+# AI Onboarding
+
+Start here when an AI agent begins work in `CentaurTechnicalIndicators-Python`.
+
+## Goal
+
+Provide one deterministic startup flow so agents can orient quickly, avoid policy misses, and make minimal, safe changes without altering public APIs unintentionally.
+
+## Startup Flow (in order)
+
+1. Read repository rules:
+   - `AGENTS.md`
+   - `.github/copilot-instructions.md`
+   - `CONTRIBUTING.md`
+2. Read project orientation:
+   - `docs/REPO_MAP.md`
+   - `AI_FRIENDLY_ROADMAP.md`
+3. Use machine-readable policy source:
+   - `ai-policy.yaml` (machine-readable contribution policy)
+4. Confirm affected modules in `src/` and keep scope focused.
+
+## Non-Negotiable Rules
+
+- Preserve the `bulk`/`single` API pattern for all indicator functions.
+- Keep public API behavior stable unless explicitly asked to introduce a breaking change.
+- Add/adjust tests in `tests/` to match any binding changes in `src/`.
+- Add a `CHANGELOG.md` entry for each user-facing change.
+- Always rebuild bindings after Rust source changes: `maturin develop`.
+
+## Agent-Friendly Change Strategy
+
+1. Identify the smallest module/file that can satisfy the task.
+2. Prefer additive or internal-only edits over broad refactors.
+3. If changing output semantics, update tests and document compatibility impact.
+4. If touching public function signatures or enum strings, include clear compatibility notes.
+
+## Required Local Validation Gates
+
+Run from repository root (after activating the virtual environment):
+
+```bash
+pip install -r test_requirements.txt
+maturin develop
+python -m pytest
+cargo fmt --check
+```
+
+## PR/Report Output Format
+
+Use this structure:
+
+1. `Summary`
+2. `Scope`
+3. `Compatibility`
+4. `Validation`
+5. `Changelog`
+
+## Quick Pointers
+
+- Python module wiring and type enums: `src/lib.rs`
+- Indicator binding implementations: `src/<module_name>.rs`
+- Python-facing tests: `tests/test_<module_name>.py`
+- Dependency versions: `Cargo.toml` (Rust), `test_requirements.txt` (Python)
+- Package metadata: `pyproject.toml`

centaur_technical_indicators-1.2.1/docs/REPO_MAP.md

@@ -0,0 +1,74 @@
+# Repository Map
+
+Quick orientation for contributors and coding agents working in `CentaurTechnicalIndicators-Python`.
+
+## Top-level layout
+
+- `src/`: Rust source files (PyO3 binding implementations for each indicator module).
+- `tests/`: Python test files (smoke tests for each binding module).
+- `assets/`: Supporting artifacts (documentation assets, banner images).
+- `.github/workflows/`: CI workflows (PR validation, release pipeline).
+- `Cargo.toml`: Rust package version and dependency configuration.
+- `pyproject.toml`: Python package metadata and maturin build settings.
+- `CHANGELOG.md`: required entry point for every user-facing change.
+- `AGENTS.md`: agent operating rules and PR/reporting expectations.
+- `docs/AI_ONBOARDING.md`: canonical start-here checklist for coding agents.
+- `AI_FRIENDLY_ROADMAP.md`: contributor-workflow and feature roadmap.
+- `CONTRIBUTING.md`: contributor expectations and required validation gates.
+
+## Source module map (`src/`)
+
+- `lib.rs`: PyO3 module wiring, shared enum type definitions (`PyConstantModelType`, `DeviationModel`, `MovingAverageType`).
+- `candle_indicators.rs`: candle/band/channel/envelope-style indicator bindings.
+- `chart_trends.rs`: peak/valley and trend-structure analysis bindings.
+- `correlation_indicators.rs`: pairwise/statistical relationship indicator bindings.
+- `momentum_indicators.rs`: momentum/oscillator indicator bindings.
+- `moving_average.rs`: moving average bindings.
+- `other_indicators.rs`: miscellaneous indicator bindings.
+- `strength_indicators.rs`: strength/participation indicator bindings.
+- `trend_indicators.rs`: trend direction/strength indicator bindings.
+- `volatility_indicators.rs`: volatility/range-expansion indicator bindings.
+
+## Test module map (`tests/`)
+
+- `test_<module_name>.py` mirrors `src/<module_name>.rs` — each test file covers binding smoke tests for the matching source module.
+
+## Extension points
+
+- New indicator binding: add to the appropriate `src/*_indicators.rs` file and wire through `src/lib.rs`.
+- New shared type/enum: add to `src/lib.rs` following the existing string-dispatch pattern.
+- Python tests: add to the matching `tests/test_<module_name>.py` file.
+- Public exports: wire through `src/lib.rs`.
+
+## If changing X, also check Y
+
+- If changing an indicator's parameter names or accepted string values:
+  - Also update the corresponding docstring in `src/<module_name>.rs`.
+  - Also update or add tests in `tests/test_<module_name>.py`.
+- If updating the upstream `centaur_technical_indicators` Rust crate version:
+  - Also update the package `version` in `Cargo.toml`.
+  - Also check for deprecation changes and adjust `#[allow(deprecated)]` annotations accordingly.
+  - Also add a user-facing entry in `CHANGELOG.md`.
+- If adding/changing public Python-facing APIs:
+  - Also update docstrings.
+  - Also add a user-facing entry in `CHANGELOG.md`.
+- If changing indicator math/outputs:
+  - Also update/add tests in the matching test module.
+- If adding new user-visible behavior:
+  - Also update `README.md` and/or examples when appropriate.
+  - Also update `CHANGELOG.md`.
+
+## Required local validation gates
+
+Run these before opening a PR:
+
+1. `maturin develop` (bindings compile cleanly)
+2. `python -m pytest` (all tests pass)
+3. `cargo fmt --check` (no formatting diffs)
+
+## Minimal PR content checklist
+
+- What changed and why.
+- Compatibility/user-impact notes.
+- Validation command summary.
+- Explicit `CHANGELOG.md` entry note.

{centaur_technical_indicators-1.2.0 → centaur_technical_indicators-1.2.1}/src/trend_indicators.rs

@@ -335,7 +335,6 @@ fn bulk_directional_movement_system(
 ///
 /// Returns:
 ///     VPT value
-#[allow(deprecated)]
 #[pyfunction(name = "volume_price_trend")]
 fn single_volume_price_trend(
     current_price: f64,
@@ -360,7 +359,6 @@ fn single_volume_price_trend(
 ///
 /// Returns:
 ///     List of VPT values
-#[allow(deprecated)]
 #[pyfunction(name = "volume_price_trend")]
 fn bulk_volume_price_trend(
     prices: Vec<f64>,