Skip to main content

Quickly serve your flask apps using ngrok

Project description

Quick Flask Server

A simple way to acess your Flask apps on the internet while running it on localhost.

Compatability

Python 3.6+ is required.

Installation

pip install quick-flask-server

Quickstart

  1. Import with from quick_flask_server import run_with_ngrok
  2. Add run_with_ngrok(app) to make your Flask app available upon running
# example.py
from flask import Flask
from quick_flask_server 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 quick_flask_server/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 

You might also see this,

sample-cli-output

You can copy the ngrok URL also from here.

As shown in the above image ngrok has a web-interface which can be accessed at localhost:4040

Here is a sample image of the web interface,

sample-ngrok-web-ui

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quick-flask-server-1.1.2.tar.gz (3.0 kB view hashes)

Uploaded Source

Built Distribution

quick_flask_server-1.1.2-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page