Giters

abhinavsingh / proxy.py

💫 Ngrok FRP Alternative • ⚡ Fast • 🪶 Lightweight • 0️⃣ Dependency • 🔌 Pluggable • 😈 TLS interception • 🔒 DNS-over-HTTPS • 🔥 Poor Man's VPN • ⏪ Reverse & ⏩ Forward • 👮🏿 "Proxy Server" framework • 🌐 "Web Server" framework • ➵ ➶ ➷ ➠ "PubSub" framework • 👷 "Work" acceptor & executor framework

Home Page:https://abhinavsingh.com/proxy-py-a-lightweight-single-file-http-proxy-server-in-python/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flowchart for better proxy plugin documentation

eherrerosj opened this issue · comments

commented

The objective of this issue is to ease the understand of the process for building new proxy plugins.

Is your feature request related to a problem? Please describe.
I have to go to check the internal source code every time I need to figure out in what order the proxy functions are executed.

Describe the solution you'd like
Having a flowchart explaining the sequence of functions that requests and responses go through.

Example
Scrapy, for example has this flowchart that results to be super useful to devs:
image

commented

@eherrerosj Thank you for raising this concern. Indeed a better diagram will help put things into perspective. Currently there is an outdated ASCII art and bunch of ipynb tutorials. I'll look into it and come up with something useful.