Skip to content

Enhance BSK usage info - #1626

Merged
schaubh merged 3 commits into
developfrom
feature/bsk_usage
Oct 17, 2026
Merged

schaubh merged 3 commits into
developfrom
feature/bsk_usage

Conversation

@schaubh

@schaubh schaubh commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor
  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

Adds a cumulative Recorded wheel download requests box above the usage plots, with coverage dates and the number of observed days. The BSK wheels plot shows seven-day trailing means of the same daily counts.

Both count requests for known BSK filenames ending in .whl from all clients, including pip, uv, browsers, Poetry, scripts, and unidentified clients. Identified mirrors and repository caches are excluded. Source archives, metadata files, signatures, and records without filenames are excluded.

The collector stores wheel requests separately in CSV and schema-version-4 JSON. Older CSV formats and summary versions 1–3 remain supported. Successful collection backfills available historical counts; missing observations remain unknown rather than becoming zero. Overlapping observations are replaced without double-counting. Broader distribution and installer totals remain available in the data artifacts.

These are recorded requests, not verified full-file transfers, completed installations, or unique users. Repeat, automated, and partial requests may count. Incomplete historical filename coverage means the total is not presented as a complete lifetime count.

Verification

  • All 45 usage-metrics tests passed.
  • Tests exercise SQL filtering for browser, Poetry, unidentified, custom-client, and mirror requests, including metadata, source archives, and missing filenames.
  • Added coverage for cumulative wheel totals, plotted values, missing versus zero counts, legacy-history migration, historical backfill, repeated collection, and source failures.
  • Validated the live ClickPy query and independently reconciled 26,843 recorded wheel requests through October 16, 2026 with the client breakdown.
  • Built the usage documentation with Sphinx warnings treated as errors and visually inspected the rendered note, download box, and plot.
  • git diff --check passed.

Documentation

Updated the note above the usage figure to explain the shared wheel-only counting rule, included clients, mirror exclusions, coverage, and interpretation limits.

Updated the usage-metrics documentation, generated README, schema documentation, and release-note snippet. Historical wheel counts remain unavailable until backfilled; broader distribution or installer totals are never substituted.

Reviewers should check the rendered usage page and generated SVG, README, CSV, and JSON summary for consistent labels and counting rules.

Future work

None

@schaubh schaubh self-assigned this Oct 17, 2026
@schaubh
schaubh requested a review from a team as a code owner October 17, 2026 15:39
@schaubh schaubh added the documentation Improvements or additions to documentation label Oct 17, 2026
@schaubh schaubh added this to Basilisk Oct 17, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-17T15:41:51.817618Z 75c3838 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@schaubh schaubh moved this to 👀 In review in Basilisk Oct 17, 2026
@schaubh
schaubh merged commit 95f9c42 into develop Oct 17, 2026
7 checks passed
schaubh added a commit that referenced this pull request Oct 17, 2026
schaubh added a commit that referenced this pull request Oct 17, 2026
@schaubh
schaubh deleted the feature/bsk_usage branch October 17, 2026 20:53
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in Basilisk Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

1 participant