Skip to content

Drop stale "polls" wording, fix __version__ drift, add pre-release testing guidance - #15

Merged
tanem merged 1 commit into
mainfrom
docs/poll-wording-and-test-guidance
Jun 11, 2026
Merged

Drop stale "polls" wording, fix __version__ drift, add pre-release testing guidance#15
tanem merged 1 commit into
mainfrom
docs/poll-wording-and-test-guidance

Conversation

@tanem

@tanem tanem commented Jun 11, 2026

Copy link
Copy Markdown
Owner

Summary

Cleanup spotted after the 1.0.0 release.

  • Stale polls wording (the poll command was renamed to export on 2026-06-07):
    • pyproject.toml description → feeds the PyPI summary.
    • src/mt5_pnl_exporter/__init__.py package docstring.
    • (GitHub repo About description updated separately via gh repo edit.)
  • __version__ drift: __init__ hardcoded "0.1.0" while the package is 1.0.0. Now derived from importlib.metadata.version("mt5-pnl-exporter"), so it tracks pyproject.toml and can't drift again.
  • CONTRIBUTING.md: new "Testing changes before a release" section — build + install the wheel on the Windows host for code changes; use TestPyPI only to rehearse publish mechanics, with its version-immutability and dependency-mirror caveats.

Left intentionally unchanged: the internal MT5 history-sync polling (_HISTORY_SYNC_POLL_S, _HISTORY_SYNC_STABLE_POLLS) — a real, current mechanism, not the old command name.

Test Plan

  • __version__ resolves to 1.0.0 (dynamic)
  • ruff, mypy strict, pytest (86 passed, 100% coverage), uv build, twine check --strict all pass locally
  • CI green on this PR

Note

The live PyPI 1.0.0 summary and its baked-in __version__ are immutable; these fixes apply to the next release. See PR discussion re: cutting 1.0.1.

🤖 Generated with Claude Code

- pyproject.toml description and the package docstring said "polls" (the
  command was renamed poll -> export). Both feed user-facing surfaces
  (PyPI summary, `help(mt5_pnl_exporter)`).
- __init__ hardcoded __version__ = "0.1.0" while the package is 1.0.0.
  Derive it from importlib.metadata so it tracks pyproject and can't
  drift again.
- CONTRIBUTING.md: add "Testing changes before a release" — build+install
  the wheel on the Windows host for code changes; TestPyPI only for
  rehearsing publish mechanics (with its version-immutability and
  dependency-mirror caveats).

The internal MT5 history-sync polling (_HISTORY_SYNC_POLL_S etc.) is a
different, current mechanism and is left as-is.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@tanem
tanem merged commit ef7c5eb into main Jun 11, 2026
1 check passed
@tanem tanem mentioned this pull request Jun 11, 2026
3 tasks
@tanem
tanem deleted the docs/poll-wording-and-test-guidance branch June 15, 2026 01:29
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.

1 participant