Skip to content

Comments

[Refactor] Upgrade README#63

Merged
vadikko2 merged 19 commits intomasterfrom
refactor-readme
Feb 21, 2026
Merged

[Refactor] Upgrade README#63
vadikko2 merged 19 commits intomasterfrom
refactor-readme

Conversation

@vadikko2
Copy link
Collaborator

@vadikko2 vadikko2 commented Feb 21, 2026

Summary by CodeRabbit

  • Documentation
    • Expanded README with comprehensive installation and quick start guides
    • Added detailed sections on Saga patterns, event handling, and Protobuf messaging
    • Updated all documentation references and code examples
    • Included Python 3.10+ requirement details and optional dependencies
    • Added integration examples for FastAPI, FastStream, and Kafka

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 21, 2026

Warning

Rate limit exceeded

@vadikko2 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 33 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

The pull request updates the README.md file with comprehensive documentation improvements, including revised installation instructions, new Table of Contents entries, updated repository references from legacy paths to python-cqrs paths, and expanded sections covering Bootstrap, Saga Pattern, Protobuf messaging, and various integrations.

Changes

Cohort / File(s) Summary
Documentation Enhancements
README.md
Extensive README updates: removed hero image styling; replaced title tagline with bold paragraph and Python 3.10+ requirements; added comprehensive Table of Contents with new sections; updated installation/quick start with pip commands and optional dependencies; systematically replaced old cqrs repository paths with python-cqrs paths throughout all code samples and documentation links; expanded Protobuf, Bootstrap, Saga Pattern, and messaging sections with concrete examples; added subsections for DI containers, mapping definitions, and saga bootstrap factory.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 The README now shines so bright,
With paths and links set right,
New sections bloom, examples gleam,
A documentation dream!
Python 3.10+ and Bootstrap dear,
Our docs are crystal clear! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: comprehensive updates and improvements to the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch refactor-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Feb 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.67%. Comparing base (37e723a) to head (f272de7).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #63   +/-   ##
=======================================
  Coverage   87.67%   87.67%           
=======================================
  Files          70       70           
  Lines        2636     2636           
=======================================
  Hits         2311     2311           
  Misses        325      325           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codspeed-hq
Copy link
Contributor

codspeed-hq bot commented Feb 21, 2026

Merging this PR will not alter performance

✅ 70 untouched benchmarks
⏩ 10 skipped benchmarks1


Comparing refactor-readme (f272de7) with master (37e723a)

Open in CodSpeed

Footnotes

  1. 10 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
README.md (1)

432-469: ⚠️ Potential issue | 🟡 Minor

Add missing imports to the bootstrap code snippet in README.md.

The code at lines 432-469 uses saga_bootstrap and MemorySagaStorage without importing them, which would raise a NameError if users copy the snippet verbatim.

Proposed fix
 from cqrs.events import bootstrap as event_bootstrap
 from cqrs.requests import bootstrap as request_bootstrap
+from cqrs.saga import bootstrap as saga_bootstrap
+from cqrs.saga.storage.memory import MemorySagaStorage
 
 from app import dependencies, mapping, orm
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 432 - 469, The README bootstrap snippet is missing
imports for saga_bootstrap and MemorySagaStorage which causes NameError when
copying; add the missing import statements at the top of the snippet to import
saga_bootstrap and MemorySagaStorage from the CQRS saga module used in the
project (so the saga_mediator_factory() call can resolve saga_bootstrap and
MemorySagaStorage), keeping the existing imports for
event_bootstrap/request_bootstrap and referencing the existing factory functions
(mediator_factory, event_mediator_factory, saga_mediator_factory) to validate
the snippet compiles.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 920-975: Delete the stale duplicate sections titled "## Mapping"
and "## Bootstrap" that were accidentally copied into the README (the block that
contains the incorrect symbol events_models); remove that entire duplicate block
so only the original, complete Mapping and Bootstrap sections (which include
CoR/Streaming/Saga mapping and saga_mediator_factory) remain, and ensure there
are no remaining references to events_models in the file (use event_models where
needed).
- Line 842: Update the three stale links that point to the old "vadikko2/cqrs"
repo: find occurrences of the URL fragment "vadikko2/cqrs" (e.g., the link
"https://github.com/vadikko2/cqrs/blob/master/examples/kafka_outboxed_event_producing.py"
and the two other matches noted) and replace them with the current repo path
used elsewhere in the README (the same base GitHub owner/name and blob/path used
by the other working links in this file) so all references are consistent;
ensure the example file paths (like kafka_outboxed_event_producing.py) remain
correct after replacement.
- Around line 45-65: Add a missing Table of Contents entry for the existing "##
Transaction log tailing" section by inserting a new bullet "- [Transaction log
tailing](`#transaction-log-tailing`)" immediately after the "- [Producing Events
from Outbox to Kafka](`#producing-events-from-outbox-to-kafka`)" line so the TOC
includes the Transaction log tailing section and the anchor matches the section
header.
- Around line 109-132: Update the Quick Start example to avoid top-level await
by moving the call to mediator.send into an async function (e.g., async def
main()) and then execute it with asyncio.run(main()); specifically, create an
async def main() that calls await mediator.send(...) (using the existing
mediator returned from bootstrap.bootstrap) and add a final line that invokes
asyncio.run(main()) so the snippet runs as a standalone script.

---

Outside diff comments:
In `@README.md`:
- Around line 432-469: The README bootstrap snippet is missing imports for
saga_bootstrap and MemorySagaStorage which causes NameError when copying; add
the missing import statements at the top of the snippet to import saga_bootstrap
and MemorySagaStorage from the CQRS saga module used in the project (so the
saga_mediator_factory() call can resolve saga_bootstrap and MemorySagaStorage),
keeping the existing imports for event_bootstrap/request_bootstrap and
referencing the existing factory functions (mediator_factory,
event_mediator_factory, saga_mediator_factory) to validate the snippet compiles.

@vadikko2 vadikko2 merged commit bf46947 into master Feb 21, 2026
11 checks passed
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