jakbin/flask-ngrokpy

Run flask with ngrok

flask-ngrokpy

This inspired from flask-ngrok

Important :-

Some time, flask-ngrok need root or sudo permission. so , if you are a non-root user, you can't use it.

And flask-ngrok download ngrok in temp directory (/tmp in linux) so if you run it after shutdown or restart, its download ngrok every time.

In flask-ngrokpy both problems are fixed.

Disclaimer:-

Use it only for educational purpose.

A simple way to demo Flask apps from your machine. Makes your Flask apps running on localhost available over the internet via the excellent ngrok tool.

Compatability

Python 3.6+ is required.

Installation

pip install flask-ngrokpy

Inside Jupyter / Colab Notebooks

Notebooks have an issue with newer versions of Flask, so force an older version if working in these environments.

!pip install flask

See the example notebook for a working example.

Quickstart

1. Import with from flask_ngrokpy import run_with_ngrok
2. Add run_with_ngrok(app) to make your Flask app available upon running

# flask_ngrok_example.py
from flask import Flask
from flask_ngrokpy import run_with_ngrok

app = Flask(__name__)
run_with_ngrok(app)  # Start ngrok when app is run

@app.route("/")
def hello():
    return "Hello World!"

if __name__ == '__main__':
    app.run()

Running the example:

python flask_ngrok_example.py
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Running on http://<random-address>.ngrok.io
 * Traffic stats available on http://127.0.0.1:4040