Skip to content

update readme#100

Merged
tsubakiky merged 3 commits intomainfrom
readme
Jul 8, 2025
Merged

update readme#100
tsubakiky merged 3 commits intomainfrom
readme

Conversation

@tsubakiky
Copy link
Collaborator

@tsubakiky tsubakiky commented Jul 8, 2025

This pull request significantly enhances the README.md file for the connect-python project, transforming it into a comprehensive guide for users and developers. The updated documentation introduces detailed explanations of the framework's features, installation steps, usage examples, streaming capabilities, multi-protocol support, and development requirements.

Documentation Improvements:

  • Framework Overview: Added an introduction to Connect Python, highlighting its interoperability between gRPC and REST, type safety with Protocol Buffers, and compatibility with HTTP infrastructure.
  • Quick Start Guide: Included step-by-step instructions for defining services, generating Python code, implementing services, running servers, and using clients.
  • Streaming Support: Explained supported streaming patterns (unary, server streaming, client streaming, and bidirectional streaming), including limitations of half-duplex bidirectional streaming.

Developer Resources:

  • Installation and Dependencies: Provided installation commands, dependency requirements (including forked libraries), and notes on protocol-specific setups.
  • Development Setup: Detailed the requirements for development, recommended tools like uv for package management, and instructions for running tests and conformance checks.

This enhancement makes the README.md file a valuable resource for both new users and contributors, ensuring clarity and ease of use.

@tsubakiky tsubakiky requested a review from zchee as a code owner July 8, 2025 09:26
@tsubakiky tsubakiky force-pushed the readme branch 6 times, most recently from 237d799 to 02c73e3 Compare July 8, 2025 10:10
@tsubakiky tsubakiky force-pushed the readme branch 2 times, most recently from b28a1e6 to 74923b8 Compare July 8, 2025 10:46
@tsubakiky tsubakiky merged commit 86a5829 into main Jul 8, 2025
4 checks passed
@tsubakiky tsubakiky deleted the readme branch July 8, 2025 11:01
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

Comments