Skip to content

chore: bump version to 1.0.0 and declare stable API#415

Open
Copilot wants to merge 3 commits intomainfrom
copilot/define-stable-api-specifications
Open

chore: bump version to 1.0.0 and declare stable API#415
Copilot wants to merge 3 commits intomainfrom
copilot/define-stable-api-specifications

Conversation

Copy link
Contributor

Copilot AI commented Mar 23, 2026

0.1.1 signals an unstable, pre-production library. This PR promotes jQuantStats to 1.0.0 and formally documents the API surface covered by semver guarantees.

Changes

  • pyproject.toml — version 0.1.11.0.0
  • uv.lock — regenerated for new version
  • CHANGELOG.md — new [1.0.0] entry with a Stable API section that enumerates every semver-protected surface:
    • Top-level exports: Portfolio, build_data, __version__
    • Portfolio factory methods (.from_cash_position, .from_risk_position) and properties (.stats, .plots, .report, .data)
    • build_data signature
    • Full Stats API (30+ methods)
    • Plots API (plot_snapshot)
    • Report API (metrics)
Original prompt

This section details on the original issue you should resolve

<issue_title>Plan 1.0.0 milestone — Current 0.1.1 signals instability; define and document what constitutes stable API for a 1.0 bump</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.

@tschm tschm marked this pull request as ready for review March 23, 2026 11:40
Copilot AI changed the title [WIP] Define and document stable API for version 1.0.0 chore: bump version to 1.0.0 and declare stable API Mar 23, 2026
Copilot AI requested a review from tschm March 23, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Plan 1.0.0 milestone — Current 0.1.1 signals instability; define and document what constitutes stable API for a 1.0 bump

2 participants