netshape 1.0.0

Local throttling proxy for testing apps under degraded network conditions.

NetShape

NetShape runs desktop apps through a local SOCKS5-capable throttling proxy so developers can test degraded network conditions without OS-level network rules or administrator privileges.

This repository is being rebuilt incrementally from the proxy-based architecture plan.

Development

python -m pip install -e ".[dev]"
python -m netshape --version

Usage

List the built-in network profiles:

netshape profiles

Run an app through the local proxy:

netshape run --profile 3g -- python -c "print('hello')"

While a session is active, use another terminal to inspect or adjust it:

netshape status
netshape adjust --latency 500ms
netshape stop

Automatically stop a long-running session:

netshape run --profile 3g --timeout 30m -- your-app-command

Verify that the proxy can handle traffic:

netshape test --profile 3g

NetShape sets ALL_PROXY=socks5://127.0.0.1:<port> for launched apps so SOCKS-aware runtimes such as Electron/Chromium can route raw TCP through the proxy. The same traffic port also still accepts HTTP proxy requests and HTTPS CONNECT tunnels for compatibility.

NetShape uses one shared bidirectional bandwidth bucket for each proxy session, so upload and download traffic compete for the configured capacity like a constrained network link. SOCKS5 UDP ASSOCIATE is not implemented yet.

The bundled profiles are a curated mix of mobile, broadband, and constrained-network presets. They intentionally diverge from the earlier mobile-only product spec so local desktop app testing can cover Wi-Fi, DSL, cable, fiber, satellite, and congested links too.

Testing

Run the automated suite:

python -m pytest

Quick CLI smoke checks:

python -m netshape --version
python -m netshape status --json
python -m netshape run --port 0 --profile 3g -- python -c "print('ok')"
python -m netshape test --profile 3g --bytes 1024

Manual proxy smoke test with real HTTP traffic:

netshape run --profile 3g -- curl http://example.com

For desktop apps, launch the app command after --; Electron and most CLI tools inherit ALL_PROXY, HTTP_PROXY, and HTTPS_PROXY from the NetShape session.