Skip to main content

Python Wisp Server

This is an implementation of a Wisp server, written in Python. It follows the Wisp v1 spec completely, including support for UDP connections.

Installation:

Install From Source:

Clone this repository and cd into it, then run the following commands:

python3 -m venv .venv
source .venv/bin/activate
pip3 install -e .

Install From PyPI:

Run the following command to install this program:

pip3 install wisp-python

To install the Cloudflare Warp proxy feature:

pip3 install wisp-python[warp]

This allows you proxy all exit traffic through Cloudflare Warp.

Running the Server:

For the best performance use CPython 3.11 or newer. PyPy is not recommended as it is a lot slower than CPython here.

To start the server, run python3 -m wisp.server. The program accepts the following arguments:

usage: wisp-server-python [-h] [--host HOST] [--port PORT] [--static STATIC] [--limits] [--bandwidth BANDWIDTH] [--connections CONNECTIONS] [--window WINDOW] [--allow-loopback] [--allow-private] [--log-level LOG_LEVEL] [--threads THREADS] [--proxy PROXY]
                          [--block-udp] [--block-tcp]

A Wisp server implementation, written in Python (v0.10.0)

options:
  -h, --help            show this help message and exit
  --host HOST           The hostname the server will listen on.
  --port PORT           The TCP port the server will listen on.
  --static STATIC       Where static files are served from.
  --limits              Enable rate limits.
  --bandwidth BANDWIDTH
                        Bandwidth limit per IP, in kilobytes per second.
  --connections CONNECTIONS
                        New connections limit per IP.
  --window WINDOW       Fixed window length for rate limits, in seconds.
  --allow-loopback      Allow connections to loopback IP addresses.
  --allow-private       Allow connections to private IP addresses.
  --log-level LOG_LEVEL
                        The log level (either debug, info, warning, error, or critical).
  --threads THREADS     The number of threads to run the server on. By default it uses all CPU cores. (Linux only)
  --proxy PROXY         The url of the socks5h, socks5, sock4a, socks4 or http proxy to use. Set this to 'warp' to use Cloudflare Warp as a proxy.
  --block-udp           Block UDP streams.
  --block-tcp           Block TCP streams.

Roadmap:

  • Rate limits
  • JSON based config files
  • UDP support
  • Ability to block local addresses
  • Wisp v2 support

This repository is licensed under the GNU AGPL v3.

A few third party libraries are used. See LICENSE_third_party.md.

wisp-server-python: a Wisp server implementation written in Python
Copyright (C) 2025 Mercury Workshop

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Metadata

Release files for wisp-python 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 wisp-python 0.10.0
File Size Uploaded Provenance Actions
wisp_python-0.10.0.tar.gz 27.5 kB Without provenance Details for wisp_python-0.10.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for wisp-python 0.10.0
File Interpreter ABI Platform Actions
wisp_python-0.10.0-py3-none-any.whl Python 3 none any Details for wisp_python-0.10.0-py3-none-any.whl

Total release size: 56.9 kB

Release files / wisp_python-0.10.0.tar.gz

Download URL wisp_python-0.10.0.tar.gz
Size 27.5 kB
Tags Source
SHA-256 checksum
How to use checksums
96424ac3922c66ef0077888647a98270a0e3ff46e1616243d0bad1b5d276c4ba
BLAKE2b-256 checksum
How to use checksums
bee504944629395c80212b3f9bbf362b9bc150ad7b902d28c709667d99dc197f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

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

Download URL wisp_python-0.10.0-py3-none-any.whl
Size 29.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a0fd3359e04857fbda420e48994357f711ec6fabb901fff7142013bf3b105b59
BLAKE2b-256 checksum
How to use checksums
edb981d25176808a92322462f4217a65caa405389df5db18c9849ca9e103bfa5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for wisp-python 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