Pratik Bhadane
307beeca02
Prepare the first public 1.0.0 release and finish the remaining CI hardening work. Highlights: - align Python, Rust, WASM, Conda, API, MCP, and docs version metadata to 1.0.0 - promote package metadata to Production/Stable and update stability/versioning docs for the stable series - move the accumulated Unreleased notes into a dated 1.0.0 changelog section and keep a fresh top-level Unreleased block - strengthen the changelog checker so it validates a single top-level Unreleased section - fix the CI/package support mismatch by declaring Python >=3.10 consistently and gating pandas-ta extras to Python 3.12+ - restore Sphinx autodoc compatibility for documented ferro_ta.<module> imports by registering module aliases - make the TA-Lib benchmark guardrail less flaky by checking median and tail-percentile speedups instead of failing on a single mild outlier - switch PyPI publishing to OIDC-only trusted publishing and wire the changelog check into the required CI gate - apply the Ruff-driven cleanup across the Python and test tree and refresh uv/cargo lockfiles Validated locally: - python3 scripts/check_changelog.py - uv run --with ruff ruff check python tests - uv run --with ruff ruff format --check python tests - uv lock --check - sphinx-build -b html docs docs/_build -W --keep-going - build/install the ferro_ta 1.0.0 wheel successfully
30 lines
1.2 KiB
Python
30 lines
1.2 KiB
Python
"""
|
|
ferro_ta.tools — Developer tools, visualisation, alerting, and workflow utilities.
|
|
|
|
Sub-modules
|
|
-----------
|
|
* :mod:`ferro_ta.tools.tools` — General-purpose utility helpers (compute_indicator, run_backtest, …)
|
|
* :mod:`ferro_ta.tools.viz` — Charting and visualisation API (matplotlib)
|
|
* :mod:`ferro_ta.tools.dashboard`— Interactive Streamlit/Dash dashboard helpers
|
|
* :mod:`ferro_ta.tools.alerts` — Alert manager and threshold checks
|
|
* :mod:`ferro_ta.tools.dsl` — Strategy expression DSL
|
|
* :mod:`ferro_ta.tools.pipeline` — Indicator pipeline builder
|
|
* :mod:`ferro_ta.tools.workflow` — Workflow automation helpers
|
|
* :mod:`ferro_ta.tools.api_info` — API discovery helpers (:func:`indicators`, :func:`info`)
|
|
* :mod:`ferro_ta.tools.gpu` — GPU-accelerated indicator support (requires PyTorch)
|
|
|
|
Example usage::
|
|
|
|
from ferro_ta.tools import compute_indicator, run_backtest, list_indicators
|
|
from ferro_ta.tools.alerts import check_cross
|
|
"""
|
|
|
|
# Re-export the stable public API from tools.tools.
|
|
# tools/tools.py has no ferro_ta module-level imports, so this is safe.
|
|
from ferro_ta.tools.tools import ( # noqa: F401
|
|
compute_indicator,
|
|
describe_indicator,
|
|
list_indicators,
|
|
run_backtest,
|
|
)
|