v4.4.56 - tearsheet metrics JSON contract release

[grzesir]

What

• bump quantstats-lumi minimum dependency to >=1.1.1 (satisfied by newly published 1.1.2)
• document 4.4.56 changelog notes for tearsheet metrics JSON contract alignment

Why

• ensure Lumibot installs a QuantStats build that emits typed tearsheet metric scalars and preserves unit semantics

Validation

• pytest:
  • tests/test_tearsheet_metrics_json.py
  • tests/test_tearsheet_custom_metrics_hook.py
  • tests/test_trader_tearsheet_metrics_passthrough.py
  • tests/test_ui_defaults.py
  • tests/test_tearsheet_quantstats_retry_unit.py
  • tests/test_tearsheet_flat_returns.py
• fresh backtest artifacts and parity checks generated under tmp/tearsheet_metrics_validation/artifacts_run6

Summary by CodeRabbit

Release Notes - Version 4.4.56

• Bug Fixes

  • Fixed tearsheet summary artifact compatibility to ensure proper handling of scalar values.

• Chores

  • Bumped minimum dependency version to enable enhanced tearsheet functionality and expanded test coverage.
  • Added funding configuration files.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Version bump to 4.4.56 with quantstats-lumi dependency update to >=1.1.1 across setup.py and requirements.txt. Changelog entry documents tearsheet compatibility fixes and new features. New funding configuration files added for GitHub Sponsors and project metadata.

Changes

Cohort / File(s)	Summary
Version & Dependency Updates setup.py, requirements.txt	Bumped package version from 4.4.55 to 4.4.56; updated quantstats-lumi constraint from >=1.1.0 to >=1.1.1 across both configuration files.
Funding Configuration .github/FUNDING.yml, funding.json	Added GitHub funding manifest with Lumiwealth sponsor reference and custom link; introduced comprehensive funding metadata file defining organization, project details (Lumibot), and sponsorship plan for Core Development & Maintenance.
Release Documentation CHANGELOG.md	New unreleased 4.4.56 entry documenting quantstats-lumi dependency requirement bump and tearsheet summary artifact compatibility fixes with contract-test coverage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• v4.4.54 - start branch #973: Modifies setup.py version parameter and updates CHANGELOG for a concurrent release.
• v4.4.43 - Hotfix: add_ohlc actually shipped #958: Also bumps package version in setuptools.setup call and updates release documentation.

Poem

🐰 A version hops forward, from fifty-five to six,
Dependencies whisper their quantstats mix,
Funding paths open, from GitHub to trade,
Tearsheets now shimmer, in contracts well-made! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change—a version release with focus on tearsheet metrics JSON contract compatibility.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch version/4.4.56

📝 Coding Plan

• Generate coding plan for human review comments

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Pylint (4.0.5)

setup.py

************* Module pylintrc
pylintrc:1:0: F0011: error while parsing the configuration: File contains no section headers.
file: 'pylintrc', line: 1
'known-third-party=lumibot' (config-parse-error)
[
{
"type": "convention",
"module": "setup",
"obj": "",
"line": 1,
"column": 0,
"endLine": null,
"endColumn": null,
"path": "setup.py",
"symbol": "missing-module-docstring",
"message": "Missing module docstring",
"message-id": "C0114"
}
]

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

CodeRabbit can approve the review once all CodeRabbit's comments are resolved.

Enable the reviews.request_changes_workflow setting to automatically approve the review once all CodeRabbit's comments are resolved.