Skip to content

HTTPX WS

WebSockets support for HTTPX

build codecov All Contributors PyPI version Downloads

Subscribe


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
François Voron

🚧 💻
Kousik Mitra
Kousik Mitra

💻
David Brochart
David Brochart

📦 💻
ysmu
ysmu

🐛
Sam Foreman
Sam Foreman

🐛
Marc-Antoine Parent
Marc-Antoine Parent

🐛 💻
Marcelo Trylesinski
Marcelo Trylesinski

🐛 🔬
MtkN1
MtkN1

🐛 🔬
Tom Christie
Tom Christie

🐛 🔬
David Montague
David Montague

🐛
Sean Wang
Sean Wang

💻
Alex Grönholm
Alex Grönholm

🐛 💻
Rodrigo de Oliveira Neto
Rodrigo de Oliveira Neto

🐛 💻
Elaina
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.