Skip to content

Address JOSS reviewer code feedback: __version__, lockfile, sample data#94

Open
vgreg wants to merge 2 commits intomainfrom
address-review-code-feedback
Open

Address JOSS reviewer code feedback: __version__, lockfile, sample data#94
vgreg wants to merge 2 commits intomainfrom
address-review-code-feedback

Conversation

@vgreg
Copy link
Copy Markdown
Owner

@vgreg vgreg commented May 6, 2026

Summary

Addresses the non-paper items from the JOSS reviewer's comment:

  • `meatpy.version` — the docs install verification snippet (`import meatpy; print(meatpy.version)`) crashed because the attribute did not exist. Now sourced from `importlib.metadata.version("meatpy")` so it cannot drift from `pyproject.toml`.
  • Version metadata alignment — `uv.lock` was stale at 0.2.11; refreshed to match `pyproject.toml` (0.4.0).
  • Sample data — adds a 590-byte synthetic ITCH 5.0 file at `samples/data/sample.itch50` plus the generator script and a quickstart that exercises the parser, processor, and LOB against fictional symbols MEAT and PYTH. Lets new users run the library end-to-end without a Nasdaq subscription.

The paper-side fixes (typos, ITCH/IEX DEEP support text) are in #92 against the paper branch.

Test plan

  • `uv run pytest` — 659 passed
  • `uv run ruff check` / `ruff format` — clean
  • `uv run python -c "import meatpy; print(meatpy.version)"` → `0.4.0`
  • `uv run python samples/itch50/00_quickstart.py` — replays the sample and prints sane top-of-book

🤖 Generated with Claude Code

vgreg and others added 2 commits May 6, 2026 08:09
The docs install snippet (`import meatpy; print(meatpy.__version__)`) was
broken because the attribute did not exist. Source it from
importlib.metadata so it stays in lockstep with pyproject.toml. Refresh
the lockfile to pick up the 0.4.0 version that was already on PyPI.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds samples/data/sample.itch50 (590 bytes, 20 messages, fictional
symbols MEAT and PYTH) so users can run the parser, processor, and
LOB end-to-end without a Nasdaq subscription. Includes the generator
script, a README, and samples/itch50/00_quickstart.py demonstrating
message-count and top-of-book reconstruction against the sample.

Addresses the JOSS reviewer's request for bundled sample data.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 60.00000% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/meatpy/__init__.py 60.00% 2 Missing ⚠️

📢 Thoughts on this report? Let us know!

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.

2 participants