frankie567/httpx-ws

WebSocket support for HTTPX

HTTPX WS

WebSockets support for HTTPX

---

Documentation: https://frankie567.github.io/httpx-ws/

Source Code: https://github.com/frankie567/httpx-ws

---

Installation

pip install httpx-ws

Features

• Sync and async client
• Helper methods to send text, binary and JSON data
• Helper methods to receive text, binary and JSON data
• Automatic ping/pong answers
• HTTPX transport to test WebSockets defined in ASGI apps
• Automatic keepalive ping
• asyncio and Trio support through AnyIO

Contributors ✨

Thanks goes to these wonderful people (emoji key):

François Voron 🚧 💻	Kousik Mitra 💻	David Brochart 📦 💻	ysmu 🐛	Sam Foreman 🐛	Marc-Antoine Parent 🐛 💻	Marcelo Trylesinski 🐛 🔬
MtkN1 🐛 🔬	Tom Christie 🐛 🔬	David Montague 🐛	Sean Wang 💻	Alex Grönholm 🐛 💻	Rodrigo de Oliveira Neto 🐛 💻	Elaina 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Development

Setup environment

We use Hatch to manage the development environment and production build. Ensure it's installed on your system.

Run unit tests

You can run all the tests with:

hatch run test

Format the code

Execute the following command to apply linting and check typing:

hatch run lint

License

This project is licensed under the terms of the MIT license.