flask-ngrok

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-ngrok

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==0.12.2

Quickstart

Import with from flask_ngrok import run_with_ngrok
Add run_with_ngrok(app) to make your Flask app available upon running

# flask_ngrok_example.py
from flask import Flask
from flask_ngrok 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

Release files for flask-ngrok 0.0.25

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flask-ngrok 0.0.25
File	Size	Uploaded
flask-ngrok-0.0.25.tar.gz	2.7 kB	Sep 9, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for flask-ngrok 0.0.25
File	Interpreter	ABI	Platform	Reset
flask_ngrok-0.0.25-py3-none-any.whl 3.1 kB Sep 9, 2018	Python 3	none	any	Details

Total release size: 5.8 kB

Release files / flask-ngrok-0.0.25.tar.gz

Download URL	flask-ngrok-0.0.25.tar.gz
Size	2.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`3f8ec704ab54b981c08d7044702f2b46023bafc4958bfeb7cbc1a905fde6ef8d`
BLAKE2b-256 checksum How to use checksums	`1e4143e7bdcc4dac453b927feff5e0c9e30f8d34ef46c19fa320256893926893`
Upload date	Sep 9, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.4`

Release files / flask_ngrok-0.0.25-py3-none-any.whl

Download URL	flask_ngrok-0.0.25-py3-none-any.whl
Size	3.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`724519a4dd3a2d374af50d4c0c21a26548737de0cf23f68dfb8d3b31c7311e93`
BLAKE2b-256 checksum How to use checksums	`af6cf54cb686ad1129e27d125d182f90f52b32f284e6c8df58c1bae54fa1adbc`
Upload date	Sep 9, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.4`