docs: refresh README for 0.5.0rc2 surface#22
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
243→376v0.2.0→v0.5.0rc2Lead with the new surface
FlowDoctor.builder()+TelegramNotifierConfiginstead of the (now@deprecated)flow_doctor.init()yaml flow.guard/monitor/ directreport) on the builder-constructed instance.report_async()+flow_doctor.context()contextvars sections.flow_doctor.testingpytest plugin +RecordingFlowDoctorsection — downstream test ergonomics, no imports required.FlowDoctorProtocolcontract for type-checked swap-in.flow_doctor.otel.report_to_otel_span_eventadapter section.Telegram becomes the recommended default
@BotFatherand the/getUpdateslookup.FLOW_DOCTOR_TELEGRAM_*.Env-var table additions
FLOW_DOCTOR_TELEGRAM_BOT_TOKEN+FLOW_DOCTOR_TELEGRAM_CHAT_IDFLOW_DOCTOR_S3_BUCKET(was missing entirely)FLOW_DOCTOR_SKIP_PREFLIGHT(documented opt-out for tests / offline boot)YAML + migration
@deprecatedmigration path; yaml shim keeps working through the 0.5.x series.Install / dev
--preduring the rc cycle; one-line explainer that the flag drops away once 0.5.0 final ships._protocol.py,testing/,otel.py,py.typed.212→376.Test plan
pytest tests/→ 376/376 pass (no code changes; docs-only).🤖 Generated with Claude Code