mitmproxy-windows

0.12.9 · active · verified Sun Apr 12

mitmproxy-windows is a Python-based shim providing a native installer for Windows users to access mitmproxy-rs, the Rust reimplementation of mitmproxy's core logic. It simplifies the installation and execution of the mitmproxy-rs command-line tool on Windows. The current version is 0.12.9, and its release cadence is tied to mitmproxy-rs releases.

Warnings

gotcha This package is a Windows-specific installer/wrapper for `mitmproxy-rs`, not a Python library intended for programmatic import and use. Its primary function is to provide an executable (`mitmproxy-windows.exe`) on Windows systems.
Fix: Do not attempt to `import mitmproxy_windows` in your Python code. Instead, install it and execute the `mitmproxy-windows.exe` command from your shell.
gotcha The core functionality and behavior are derived directly from the `mitmproxy-rs` project (written in Rust). While `mitmproxy-windows` simplifies its deployment, understanding `mitmproxy-rs` documentation is crucial for advanced usage and troubleshooting.
Fix: Refer to the `mitmproxy-rs` documentation and GitHub repository for details on CLI arguments, features, and functionality.
gotcha The `mitmproxy-windows` package is specifically designed for Windows operating systems. It will not install or function correctly on macOS or Linux.
Fix: For non-Windows systems, refer to the `mitmproxy-rs` documentation for alternative installation methods (e.g., building from source or using direct `mitmproxy-rs` binaries).
breaking Breaking changes in the underlying `mitmproxy-rs` project (e.g., changes to CLI arguments, output formats, or core proxy behavior) will directly impact users of `mitmproxy-windows`.
Fix: Always check the release notes for `mitmproxy-rs` when updating `mitmproxy-windows` to be aware of potential breaking changes.

Install

pip install mitmproxy-windows Install

Quickstart

Installs the mitmproxy-windows shim and demonstrates how to run the underlying mitmproxy-rs executable it provides on Windows.

# Install the shim (if not already done)
pip install mitmproxy-windows

# After installation, run the mitmproxy-windows executable from your shell
# To check the version:
# mitmproxy-windows.exe --version

# To start the proxy:
# mitmproxy-windows.exe

# You can use standard mitmproxy-rs CLI arguments, e.g., to run in headless mode:
# mitmproxy-windows.exe --mode transparent --listen-host 127.0.0.1 --listen-port 8080

view raw JSON →