A Python wrapper for Ngrok.
Project description
pyngrok - a Python wrapper for ngrok
pyngrok
is a Python wrapper for ngrok that manages its own binary and puts
it on our path, making ngrok
readily available from anywhere on the command line and via a
convenient Python API.
Installation
pyngrok
is available on PyPI and can be installed
using pip
.
pip install pyngrok
That's it! pyngrok
is now available as a package to our Python projects, and ngrok
is now available from
the command line.
Basic Usage
To open a tunnel, use the connect()
method, which returns the public URL generated by ngrok
.
from pyngrok import ngrok
# Open a tunnel on the default port 80
public_url = ngrok.connect()
The connect()
method can also take an options
parameter, which allows us to pass additional
options that are supported by ngrok.
This package also puts the default ngrok
binary on our path, so all features of ngrok
are also
available on the command line.
ngrok http 80
For details on how to fully leverage ngrok
from the command line, see ngrok's official documentation.
Documentation
For more advanced usage, the full documentation is available at http://pyngrok.readthedocs.io.
Contributing
If you find issues, report them on GitHub. Pull requests for fixes and features are also warmly welcomed.
Be sure to review the Contribution Guide and Code of Conduct before submitting issues or pull requests.
Want to contribute financially? If you've found pyngrok
useful, a donation would
also be greatly appreciated!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.