{"repo":"alexdlaird/pyngrok","free":true,"listed":false,"github":"https://github.com/alexdlaird/pyngrok","clone":"git clone https://github.com/alexdlaird/pyngrok.git","description":"A Python wrapper for ngrok; programmatic tunnels for ingress, webhooks, demos, and APIs","language":"Python","stars":464,"topics":["ngrok","tunneling","python","tunnel","webhook","localhost","reverse-proxy"],"license":"MIT","category":"networking-infra","readme_excerpt":"pyngrok is a Python wrapper for ngrok that manages its own binary, making ngrok available via a convenient Python API and the command line. ngrok is a reverse proxy that opens secure tunnels from public URLs to localhost. It's perfect for rapid development (test webhooks, demo local websites, enable SSH access), establishing ingress to external networks and devices, building production APIs (traffic policies, OAuth, load balancing), and more. And it's made even more powerful with native Python integration through the pyngrok client. Installation pyngrok is available on PyPI and can be installed using pip : or conda : That's it! pyngrok is now available as a package to your Python projects, and ngrok is now available from the command line. Basic Usage Open a Tunnel To open a tunnel, use the connect method, which returns a NgrokTunnel , and this returned object has a reference to the public URL generated by ngrok in its public url attribute. The connect method takes kwargs as well, which allows you to pass additional tunnel configurations that are supported by ngrok (or the name of a tunnel defined in ngrok 's config file), as documented here. Note: pyngrok unifies ngrok 's \"tunnel\" (v2) and \"endpoint\" (v3) concepts behind a single API: connect() returns an NgrokTunnel and handles the differences for you through the config version you set. All ngrok features are available to you through this. For v3-specific Endpoints, see Using v3 Endpoints. ngrok 's API The api method allows ","default_branch":null,"files":null,"tree":[],"storefront":"/r/alexdlaird","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/alexdlaird/pyngrok/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}