Skip to content

docs: refresh README for 0.5.0rc2 surface#22

Merged
cipher813 merged 2 commits into
mainfrom
feat/readme-refresh-0.5.0rc2
May 13, 2026
Merged

docs: refresh README for 0.5.0rc2 surface#22
cipher813 merged 2 commits into
mainfrom
feat/readme-refresh-0.5.0rc2

Conversation

@cipher813
Copy link
Copy Markdown
Owner

Summary

README had drifted to the 0.2.0-era surface. Pulls it forward to cover everything we shipped across 0.5.0rc1 + rc2.

Badges

  • Tests 243376
  • PyPI v0.2.0v0.5.0rc2
  • New: PEP 561 typed marker

Lead with the new surface

  • Quick Start now shows FlowDoctor.builder() + TelegramNotifierConfig instead of the (now @deprecated) flow_doctor.init() yaml flow.
  • All three pipeline-integration idioms (guard / monitor / direct report) on the builder-constructed instance.
  • report_async() + flow_doctor.context() contextvars sections.
  • flow_doctor.testing pytest plugin + RecordingFlowDoctor section — downstream test ergonomics, no imports required.
  • FlowDoctorProtocol contract for type-checked swap-in.
  • flow_doctor.otel.report_to_otel_span_event adapter section.

Telegram becomes the recommended default

  • Five-notifier table (Telegram / Slack / Email / GitHub / S3) replaces the old four-line "Notifications" bullet list.
  • Setup recipes pointing at @BotFather and the /getUpdates lookup.
  • Env-var quickstart leads with FLOW_DOCTOR_TELEGRAM_*.

Env-var table additions

  • FLOW_DOCTOR_TELEGRAM_BOT_TOKEN + FLOW_DOCTOR_TELEGRAM_CHAT_ID
  • FLOW_DOCTOR_S3_BUCKET (was missing entirely)
  • FLOW_DOCTOR_SKIP_PREFLIGHT (documented opt-out for tests / offline boot)

YAML + migration

  • YAML config example refreshed to lead with telegram + s3 entries.
  • New "Migrating from 0.4.x" section showing the PEP 702 @deprecated migration path; yaml shim keeps working through the 0.5.x series.

Install / dev

  • Install commands carry --pre during the rc cycle; one-line explainer that the flag drops away once 0.5.0 final ships.
  • Architecture diagram updated with the three subpackages added in this release: _protocol.py, testing/, otel.py, py.typed.
  • Tests count in the Development section bumped 212376.

Test plan

  • pytest tests/ → 376/376 pass (no code changes; docs-only).
  • GitHub markdown renderer sanity — no broken anchors / mis-rendered code fences (will visually verify on the PR page).

🤖 Generated with Claude Code

cipher813 and others added 2 commits May 13, 2026 13:51
Pull the README forward from the 0.2.0-era surface it had drifted to.

Badges:
- Tests 243 → 376 passing
- PyPI v0.2.0 → v0.5.0rc2
- New: PEP 561 typed marker

Lead with the new surface:
- Quick Start now shows FlowDoctor.builder() + TelegramNotifierConfig
  instead of the (now @deprecated) flow_doctor.init() yaml flow.
- All three pipeline-integration idioms (guard / monitor / direct
  report) on the builder-constructed instance.
- report_async() + flow_doctor.context() contextvars sections.
- flow_doctor.testing pytest plugin + RecordingFlowDoctor section
  (downstream test ergonomics — no imports required).
- FlowDoctorProtocol contract for type-checked swap-in.
- flow_doctor.otel.report_to_otel_span_event adapter section.

Telegram becomes the recommended default in the notifier table + the
env-var quickstart. The five-notifier table (Telegram / Slack / Email /
GitHub / S3) replaces the old four-line "Notifications" bullet list.
Setup recipes pointing at @Botfather and the /getUpdates lookup.

Env-var table additions:
- FLOW_DOCTOR_TELEGRAM_BOT_TOKEN + FLOW_DOCTOR_TELEGRAM_CHAT_ID
- FLOW_DOCTOR_S3_BUCKET (was missing entirely)
- FLOW_DOCTOR_SKIP_PREFLIGHT (documented opt-out for tests / offline boot)

YAML config example refreshed to lead with telegram + s3 entries (was
github + email).

New "Migrating from 0.4.x" section showing the PEP 702 @deprecated
path: yaml shim keeps working through the deprecation window, removed
in 0.6.0.

Install commands carry --pre during the rc cycle; note explains the
flag drops away once 0.5.0 final ships.

Architecture diagram updated with the three subpackages added in this
release: _protocol.py, testing/, otel.py, py.typed marker. Custom-
notifier extension point called out under Notifications. Tests count
in the Development section bumped 212 → 376.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@cipher813 cipher813 merged commit 681fdf9 into main May 13, 2026
1 check passed
@cipher813 cipher813 deleted the feat/readme-refresh-0.5.0rc2 branch May 13, 2026 20:53
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