Docs and examples to top level

1 files changed, 16 insertions, 0 deletions

diff --git a/examples/filt.py b/examples/filt.py
new file mode 100644
index 00000000..f99b675c
--- /dev/null
+++ b/examples/filt.py
@@ -0,0 +1,16 @@
+# This scripts demonstrates how to use mitmproxy's filter pattern in inline scripts.
+# Usage: mitmdump -s "filt.py FILTER"
+
+from mitmproxy import filt
+
+
+def start(context, argv):
+    if len(argv) != 2:
+        raise ValueError("Usage: -s 'filt.py FILTER'")
+    context.filter = filt.parse(argv[1])
+
+
+def response(context, flow):
+    if flow.match(context.filter):
+        print("Flow matches filter:")
+        print(flow)