Introduce file change detection

[leoyala]

Summary

This PR refactors CcvReader to extract the file change detection into unique separate methods.

Changes

• Refactors CsvReader to reduce responsabilities of each method.
• Improves documentation across the project.

Test plan

• uv run pytest passes

Summary by CodeRabbit

• Documentation

  • Added a comprehensive getting-started guide covering installation, dataset tracking, snapshots, lineage, renamed files, storage, and benchmarking.
  • Updated project requirements to Python 3.11+.
  • Refreshed feature descriptions, quickstart examples, roadmap details, and completed milestone items.

• Bug Fixes

  • Improved CSV file consistency checks to detect changes reliably between schema inspection and data processing, preventing inconsistent reads.

[coderabbitai]

Warning

Review limit reached

@leoyala, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 14 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d5296e34-5bff-420a-924b-1cba4159cabb

📥 Commits

Reviewing files that changed from the base of the PR and between 098ea37 and a5e1100.

📒 Files selected for processing (2)

• docs/decisions/0003-local-snapshot-store-layout.md
• docs/roadmap.md

📝 Walkthrough

Walkthrough

The PR expands user documentation and roadmap status, adds a complete getting-started guide, centralizes CSV file-change validation, and updates a profiling comment.

Changes

Documentation updates

Layer / File(s)	Summary
Getting Started workflow docs/getting_started.md	Documents installation, tracking, immutable snapshots, lineage continuation, on-disk storage, benchmarking, and roadmap references.
README and landing-page walkthrough README.md, docs/index.md	Adds Python requirements, CLI walkthroughs, expanded feature descriptions, and drift-monitoring roadmap messaging.
Roadmap status formatting docs/roadmap.md	Reformats milestone headings and marks completed v0.2 capabilities while leaving dstrack log unchecked.

CSV reader validation

Layer / File(s)	Summary
Centralized CSV file-change checks src/dstrack/readers/_csv.py	Adds helpers for (mtime_ns, size) signatures and uses shared validation during schema detection and batch iteration.

Profiling documentation cleanup

Layer / File(s)	Summary
Profiling frame-key comment src/dstrack/_benchmark/_profiling.py	Updates the pstats frame-key documentation without changing behavior.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• leoyala/dstrack#13: Both changes update CSV file-change signature validation.

Suggested labels: documentation

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main code change: adding file change detection in CsvReader.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 20-introduce-file-change-handler-in-csvreader

---

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.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[github-actions]

Test Results

   48 files  ±0     48 suites  ±0   1m 13s ⏱️ -1s
  206 tests ±0    206 ✅ ±0  0 💤 ±0  0 ❌ ±0 
4 944 runs  ±0  4 944 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit a5e1100. ± Comparison against base commit c0fac9b.

♻️ This comment has been updated with latest results.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/getting_started.md`:
- Around line 82-85: Align the walkthrough output with the current dstrack track
CLI by removing the unsupported “Stored at ...” example line from
docs/getting_started.md (82-85), README.md (54-58), and docs/index.md (44-48);
do not change the CLI implementation.

In `@docs/roadmap.md`:
- Line 27: Update the completed CLI milestone in docs/roadmap.md to reference
dstrack track instead of dstrack snapshot, preserving the existing checklist
formatting.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 29592304-8edf-48cd-8d69-f286aaa8a8f6

📥 Commits

Reviewing files that changed from the base of the PR and between c0fac9b and 098ea37.

📒 Files selected for processing (6)

• README.md
• docs/getting_started.md
• docs/index.md
• docs/roadmap.md
• src/dstrack/_benchmark/_profiling.py
• src/dstrack/readers/_csv.py