Skip to content

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

Merged
vgreg merged 35 commits into
mainfrom
address-review-code-feedback
May 12, 2026
Merged

Address JOSS reviewer code feedback: __version__, lockfile, sample data#94
vgreg merged 35 commits into
mainfrom
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 21 commits July 26, 2025 09:29
@vgreg
Initial draft of paper for JOSS submission
7b8d346
@vgreg
Fixed draft-pdf workflow
e166979
@vgreg
Fixed a bad reference to current_lob in before_lob_update
20eb209
@vgreg
Updated tests to reflect expected behavior
c009cfc
@github-actions @vgreg
chore: bump version to 0.2.8
f994583
@vgreg
Bump version from 0.2.8 to 0.2.10
8bfc2b7
@vgreg
Merge pull request #73 from vgreg/main
d80e8eb 
Update to main
@vgreg
Edited the paper to include the newly required sections.
d095814
@vgreg
Updated research impact
6e9eb77
@vgreg
Updated "State of the Field" section
8b8c5d2
@dependabot
chore(deps): bump tornado from 6.5.1 to 6.5.5
066ed43 
Bumps [tornado](https://github.com/tornadoweb/tornado) from 6.5.1 to 6.5.5.
- [Changelog](https://github.com/tornadoweb/tornado/blob/master/docs/releases.rst)
- [Commits](tornadoweb/tornado@v6.5.1...v6.5.5)

---
updated-dependencies:
- dependency-name: tornado
  dependency-version: 6.5.5
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
chore(deps): bump requests from 2.32.4 to 2.33.0
70ef3e9 
Bumps [requests](https://github.com/psf/requests) from 2.32.4 to 2.33.0.
- [Release notes](https://github.com/psf/requests/releases)
- [Changelog](https://github.com/psf/requests/blob/main/HISTORY.md)
- [Commits](psf/requests@v2.32.4...v2.33.0)

---
updated-dependencies:
- dependency-name: requests
  dependency-version: 2.33.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
chore(deps): bump pygments from 2.19.2 to 2.20.0
0fafac8 
Bumps [pygments](https://github.com/pygments/pygments) from 2.19.2 to 2.20.0.
- [Release notes](https://github.com/pygments/pygments/releases)
- [Changelog](https://github.com/pygments/pygments/blob/master/CHANGES)
- [Commits](pygments/pygments@2.19.2...2.20.0)

---
updated-dependencies:
- dependency-name: pygments
  dependency-version: 2.20.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
chore(deps-dev): bump pytest from 8.4.1 to 9.0.3
ef41abe 
Bumps [pytest](https://github.com/pytest-dev/pytest) from 8.4.1 to 9.0.3.
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](pytest-dev/pytest@8.4.1...9.0.3)

---
updated-dependencies:
- dependency-name: pytest
  dependency-version: 9.0.3
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
chore(deps): bump nbconvert from 7.16.6 to 7.17.1
ea18d77 
Bumps [nbconvert](https://github.com/jupyter/nbconvert) from 7.16.6 to 7.17.1.
- [Release notes](https://github.com/jupyter/nbconvert/releases)
- [Changelog](https://github.com/jupyter/nbconvert/blob/main/CHANGELOG.md)
- [Commits](jupyter/nbconvert@v7.16.6...v7.17.1)

---
updated-dependencies:
- dependency-name: nbconvert
  dependency-version: 7.17.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
chore(deps): bump notebook from 7.4.4 to 7.5.6
947374c 
Bumps [notebook](https://github.com/jupyter/notebook) from 7.4.4 to 7.5.6.
- [Release notes](https://github.com/jupyter/notebook/releases)
- [Changelog](https://github.com/jupyter/notebook/blob/@jupyter-notebook/tree@7.5.6/CHANGELOG.md)
- [Commits](https://github.com/jupyter/notebook/compare/@jupyter-notebook/tree@7.4.4...@jupyter-notebook/tree@7.5.6)

---
updated-dependencies:
- dependency-name: notebook
  dependency-version: 7.5.6
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot
chore(deps): bump jupyterlab from 4.4.8 to 4.5.7
289e553 
Bumps [jupyterlab](https://github.com/jupyterlab/jupyterlab) from 4.4.8 to 4.5.7.
- [Release notes](https://github.com/jupyterlab/jupyterlab/releases)
- [Changelog](https://github.com/jupyterlab/jupyterlab/blob/main/RELEASE.md)
- [Commits](https://github.com/jupyterlab/jupyterlab/compare/@jupyterlab/lsp@4.4.8...@jupyterlab/lsp@4.5.7)

---
updated-dependencies:
- dependency-name: jupyterlab
  dependency-version: 4.5.7
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@vgreg @claude
Address JOSS reviewer comments on paper
eb2095a 
Fixed typos and updated the supported-formats footnote to reflect
current ITCH (2.0-5.0) and IEX DEEP support.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dependabot
chore(deps): bump jupyter-server from 2.16.0 to 2.18.0
e5e6aee 
Bumps [jupyter-server](https://github.com/jupyter-server/jupyter_server) from 2.16.0 to 2.18.0.
- [Release notes](https://github.com/jupyter-server/jupyter_server/releases)
- [Changelog](https://github.com/jupyter-server/jupyter_server/blob/main/CHANGELOG.md)
- [Commits](jupyter-server/jupyter_server@v2.16.0...v2.18.0)

---
updated-dependencies:
- dependency-name: jupyter-server
  dependency-version: 2.18.0
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@vgreg @claude
feat: expose meatpy.__version__ and refresh uv.lock
22ca754 
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>
@vgreg @claude
docs: ship synthetic ITCH 5.0 sample and quickstart
03500cb 
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

codecov-commenter commented May 6, 2026

⚠️ 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!

dependabot Bot and others added 8 commits May 8, 2026 05:08
@dependabot
chore(deps): bump mistune from 3.1.3 to 3.2.1
5789676 
Bumps [mistune](https://github.com/lepture/mistune) from 3.1.3 to 3.2.1.
- [Release notes](https://github.com/lepture/mistune/releases)
- [Changelog](https://github.com/lepture/mistune/blob/main/docs/changes.rst)
- [Commits](lepture/mistune@v3.1.3...v3.2.1)

---
updated-dependencies:
- dependency-name: mistune
  dependency-version: 3.2.1
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
@vgreg
Merge pull request #92 from vgreg/handle-referee-comments
e48a9e2 
Address JOSS reviewer typos and clarify format support
@vgreg
Merge pull request #85 from vgreg/dependabot/uv/tornado-6.5.5
3f43262 
chore(deps): bump tornado from 6.5.1 to 6.5.5
@vgreg
Merge pull request #86 from vgreg/dependabot/uv/requests-2.33.0
70bc6be 
chore(deps): bump requests from 2.32.4 to 2.33.0
@vgreg
Merge pull request #87 from vgreg/dependabot/uv/pygments-2.20.0
83bd0c1 
chore(deps): bump pygments from 2.19.2 to 2.20.0
@vgreg
Merge pull request #88 from vgreg/dependabot/uv/pytest-9.0.3
fb28271 
chore(deps-dev): bump pytest from 8.4.1 to 9.0.3
@vgreg
Merge pull request #89 from vgreg/dependabot/uv/nbconvert-7.17.1
02b4b6d 
chore(deps): bump nbconvert from 7.16.6 to 7.17.1
@vgreg
Merge pull request #90 from vgreg/dependabot/uv/notebook-7.5.6
f8cf25a 
chore(deps): bump notebook from 7.4.4 to 7.5.6
vgreg and others added 6 commits May 12, 2026 07:19
@vgreg
Merge pull request #91 from vgreg/dependabot/uv/jupyterlab-4.5.7
09ffae4 
chore(deps): bump jupyterlab from 4.4.8 to 4.5.7
@vgreg
Merge pull request #93 from vgreg/dependabot/uv/jupyter-server-2.18.0
738ee5c 
chore(deps): bump jupyter-server from 2.16.0 to 2.18.0
@vgreg
Merge pull request #95 from vgreg/dependabot/uv/mistune-3.2.1
5769e94 
chore(deps): bump mistune from 3.1.3 to 3.2.1
@vgreg @claude
docs: surface bundled ITCH 5.0 quickstart and fix LOB example
f325393 
Add a top-level pointer in the getting-started guide and the landing page to
the synthetic samples/data/sample.itch50 + samples/itch50/00_quickstart.py
end-to-end flow so users can try MeatPy without a Nasdaq subscription. Fix
the LOB code snippet to use `processor.current_lob` (the actual attribute)
and drop the redundant `/ 10000` since `best_bid`/`best_ask` already return
a Decimal scaled to dollars.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vgreg @claude
fix(docs): bump pymdown-extensions to unbreak mkdocs build on pygment…
6ca1c14 
…s 2.20

Pygments 2.20.0 calls `html.escape(filename)` in `HtmlFormatter.__init__`,
which crashes when pymdown-extensions' highlight formatter passes
`filename=None` for code blocks without a title. The fix landed in
pymdown-extensions 10.21.2.

Add an explicit lower bound in the docs group so transitive resolution
through mkdocs-material can't pull the broken 10.16.x line back in, and
refresh uv.lock (pymdown-extensions 10.16.1 -> 10.21.2). `mkdocs build
--strict` now succeeds.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vgreg
Merge pull request #96 from vgreg/64-submit-paper-to-joss
809a9a4 
Bring JOSS paper into address-review-code-feedback
@vgreg vgreg merged commit c43394d into main May 12, 2026
6 checks passed
@vgreg vgreg deleted the address-review-code-feedback branch May 12, 2026 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vgreg @codecov-commenter