From ec54bd1a16203429452c4d3117f70b38a450ad08 Mon Sep 17 00:00:00 2001 From: Ryan Clark Date: Wed, 15 Jul 2026 07:01:22 -0500 Subject: [PATCH] docs: update README and index with WebSocket support and acknowledgments --- README.md | 14 ++++++++++++-- docs/index.md | 11 ++++++++++- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 637d985e..06726832 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Package version

-HTTPX2 is a fully featured HTTP client library for Python. It includes **an integrated command line client**, has support for both **HTTP/1.1 and HTTP/2**, and provides both **sync and async APIs**. +HTTPX2 is a fully featured HTTP client library for Python. It includes **an integrated command line client**, has support for both **HTTP/1.1 and HTTP/2**, supports **WebSockets**, and provides both **sync and async APIs**. > [!NOTE] > HTTPX2 is a continuation of the wonderful work started by [@lovelydinosaur](https://github.com/lovelydinosaur) and the broader HTTPX community. We're enormously grateful for everything that has gone into HTTPX over the years - it has been a foundational piece of the modern Python ecosystem, and this project would not exist without it. @@ -57,6 +57,7 @@ HTTPX2 builds on the well-established usability of `requests`, and gives you: * An integrated command-line client. * HTTP/1.1 [and HTTP/2 support](https://httpx2.pydantic.dev/http2/). * Standard synchronous interface, but with [async support if you need it](https://httpx2.pydantic.dev/async/). +* [WebSocket support](https://httpx2.pydantic.dev/websockets/). * Ability to make requests directly to [WSGI applications](https://httpx2.pydantic.dev/advanced/transports/#wsgi-transport) or [ASGI applications](https://httpx2.pydantic.dev/advanced/transports/#asgi-transport). * Strict timeouts everywhere. * Fully type annotated. @@ -94,13 +95,19 @@ Or, to include the optional HTTP/2 support, use: pip install httpx2[http2] ``` +Or, to include the optional WebSocket support, use: + +```shell +pip install 'httpx2[ws]' +``` + ## Documentation Project documentation is available at [https://httpx2.pydantic.dev/](https://httpx2.pydantic.dev/). For a run-through of all the basics, head over to the [QuickStart](https://httpx2.pydantic.dev/quickstart/). -For more advanced topics, see the [Advanced Usage](https://httpx2.pydantic.dev/advanced/) section, the [async support](https://httpx2.pydantic.dev/async/) section, or the [HTTP/2](https://httpx2.pydantic.dev/http2/) section. +For more advanced topics, see the [Advanced Usage](https://httpx2.pydantic.dev/advanced/) section, the [async support](https://httpx2.pydantic.dev/async/) section, the [HTTP/2](https://httpx2.pydantic.dev/http2/) section, or the [WebSockets](https://httpx2.pydantic.dev/websockets/) section. The [Developer Interface](https://httpx2.pydantic.dev/api/) provides a comprehensive API reference. @@ -124,6 +131,7 @@ As well as these optional installs: * `h2` - HTTP/2 support. *(Optional, with `httpx2[http2]`)* * `socksio` - SOCKS proxy support. *(Optional, with `httpx2[socks]`)* +* `wsproto` - WebSocket support. *(Optional, with `httpx2[ws]`)* * `rich` - Rich terminal support. *(Optional, with `httpx2[cli]`)* * `click` - Command line client support. *(Optional, with `httpx2[cli]`)* * `brotli` or `brotlicffi` - Decoding for "brotli" compressed responses. *(Optional, with `httpx2[brotli]`)* @@ -133,6 +141,8 @@ A huge amount of credit is due to `requests` for the API layout that much of this work follows, as well as to `urllib3` for plenty of design inspiration around the lower-level networking details. +We also want to acknowledge the excellent [httpx-ws](https://github.com/frankie567/httpx-ws) package by [François Voron](https://github.com/frankie567), which served as the foundation for HTTPX2's native WebSocket support. + ---

HTTPX2 is BSD licensed code.
Designed & crafted with care.
— 🦋 —

diff --git a/docs/index.md b/docs/index.md index a149da3d..e5277a8d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ HTTPX2 A next-generation HTTP client for Python. -HTTPX2 is a fully featured HTTP client for Python, which provides sync and async APIs, and support for both HTTP/1.1 and HTTP/2. +HTTPX2 is a fully featured HTTP client for Python, which provides sync and async APIs, support for both HTTP/1.1 and HTTP/2, and native support for WebSockets. !!! note HTTPX2 is a continuation of the wonderful work started by [@lovelydinosaur](https://github.com/lovelydinosaur) and the broader HTTPX community. We're enormously grateful for everything that has gone into HTTPX over the years - it has been a foundational piece of the modern Python ecosystem, and this project would not exist without it. @@ -67,6 +67,7 @@ HTTPX2 builds on the well-established usability of `requests`, and gives you: * A broadly [requests-compatible API](compatibility.md). * Standard synchronous interface, but with [async support if you need it](async.md). * HTTP/1.1 [and HTTP/2 support](http2.md). +* [WebSocket support](websockets.md). * Ability to make requests directly to [WSGI applications](advanced/transports.md#wsgi-transport) or [ASGI applications](advanced/transports.md#asgi-transport). * Strict timeouts everywhere. * Fully type annotated. @@ -125,6 +126,8 @@ A huge amount of credit is due to `requests` for the API layout that much of this work follows, as well as to `urllib3` for plenty of design inspiration around the lower-level networking details. +We also want to acknowledge the excellent [httpx-ws](https://github.com/frankie567/httpx-ws) package by [François Voron](https://github.com/frankie567), which served as the foundation for HTTPX2's native WebSocket support. + ## Installation Install with pip: @@ -139,6 +142,12 @@ Or, to include the optional HTTP/2 support, use: pip install 'httpx2[http2]' ``` +Or, to include the optional WebSocket support, use: + +```shell +pip install 'httpx2[ws]' +``` + To include the optional brotli and zstandard decoders support, use: ```shell