Enhance documentation and examples for FastAPI Pub/Sub integration with PGMQ#43
Conversation
jason810496
commented
Jan 7, 2026
jason810496
commented
- Added a new FastAPI Pub/Sub example documentation.
- Updated README to include links to transaction usage and FastAPI example.
- Improved getting started guide with FastAPI Pub/Sub reference.
- Refactored example scripts to use configurable API port.
- Enhanced integration tests for FastAPI example.
…th PGMQ - Added a new FastAPI Pub/Sub example documentation. - Updated README to include links to transaction usage and FastAPI example. - Improved getting started guide with FastAPI Pub/Sub reference. - Refactored example scripts to use configurable API port. - Enhanced integration tests for FastAPI example.
Summary of ChangesHello @jason810496, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's documentation and examples by introducing a new, real-world FastAPI Pub/Sub integration example with PGMQ. This example showcases how to effectively use Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly enhances the documentation and examples for using pgmq-sqlalchemy with FastAPI. The new documentation provides a comprehensive real-world example, complete with setup instructions, architecture overview, and integration tests. The example code has also been refactored for better configurability. My review focuses on improving the clarity and correctness of the new documentation. I've pointed out a couple of minor issues in the documentation files that could affect user experience, such as a typo in a command and inconsistent indentation.
|
|
||
| - Uses sync database driver (psycopg2) | ||
| - Uses ``PGMQOperation`` (imported as ``op``) for publishing messages | ||
| - Provides REST endpoints for creating and retrieving orders |
There was a problem hiding this comment.
This line uses a tab character for indentation, while the surrounding lines use spaces. In reStructuredText, mixing tabs and spaces can lead to inconsistent rendering or errors. Please replace the tab with spaces to ensure consistent formatting.
| - Provides REST endpoints for creating and retrieving orders | |
| - Provides REST endpoints for creating and retrieving orders |
| Install dependencies from the project root with ``uv``:: | ||
|
|
||
| cd /path/to/pgmq-sqlalchemy | ||
| uv ync --group dev |
There was a problem hiding this comment.
There's a typo in the uv command. It should be uv sync instead of uv ync.
| uv ync --group dev | |
| uv sync --group dev |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
1 participant
