Skip to main content

HTTPX WS

WebSockets support for HTTPX

build codecov All Contributors PyPI version Downloads


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

💻
runsisi
runsisi

🐛 🔬
Luis Linares
Luis Linares

🐛
Graeme Holliday
Graeme Holliday

🐛 💻
Ilia Ablamonov
Ilia Ablamonov

🐛

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

Development

Setup environment

We use uv to manage the development environment and production build, and just to manage command shortcuts. Ensure they are installed on your system.

Run just install to install the development dependencies and pre-commit hooks.

Run unit tests

You can run all the tests with:

just test

Format the code

Execute the following command to apply linting and check typing:

just lint

Documentation

Use just docs-serve to preview the Zensical site and just docs-build to build it into site/.

Publishing a release

  1. Commit the release entries under Unreleased in CHANGELOG.md. From a clean release branch with Git signing configured, run just version patch, just version minor, or just version major. The recipe updates the version, changelog, and lockfile and creates a signed commit.
  2. Preview the release body with just release-notes <version>, then push the branch and merge the release PR into main.
  3. With the GitHub CLI authenticated, run just release <PR number>. This signs and pushes a tag for the exact commit that landed, even if main has advanced. CI publishes to PyPI and creates a draft GitHub release after the checks pass.

The PyPI Trusted Publisher must match build.yml and the GitHub release environment.

License

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

Metadata

Release files for httpx-ws 0.10.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for httpx-ws 0.10.0
File Size Uploaded Provenance Actions
httpx_ws-0.10.0.tar.gz 127.3 kB Without provenance Details for httpx_ws-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for httpx-ws 0.10.0
File Interpreter ABI Platform Actions
httpx_ws-0.10.0-py3-none-any.whl Python 3 none any Details for httpx_ws-0.10.0-py3-none-any.whl

Total release size: 144.0 kB

Release files / httpx_ws-0.10.0.tar.gz

Download URL httpx_ws-0.10.0.tar.gz
Size 127.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d8d6c3f6d787a60d94e244bf4bf6c47dfd33981e7e749ce2bd0dccc479b09734
BLAKE2b-256 checksum
How to use checksums
f8162699ab005a052c5ddf8811a5a29a81c08bb02f62839d27769a74ae7fc040
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / httpx_ws-0.10.0-py3-none-any.whl

Download URL httpx_ws-0.10.0-py3-none-any.whl
Size 16.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62ed6eb42acbfdad4b10cb0856f60d8bec0096b2c7c22c10b7814cb79d056d8c
BLAKE2b-256 checksum
How to use checksums
a63eae8e8c55d0fa4429c198e91aa82622f065332ddacfe6c5e9740a7ddec15f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for httpx-ws 0.10.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page