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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file quick-flask-server-1.1.2.tar.gz.

File metadata

  • Download URL: quick-flask-server-1.1.2.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for quick-flask-server-1.1.2.tar.gz
Algorithm Hash digest
SHA256 decb1f3ea670fa8ef3a31237d7bf94f1badf9b1f1d643b9b7482231a0af47420
MD5 48575d82b74dd744f379770313913d2c
BLAKE2b-256 3f9f1bdaded81c575bb72517bbd771f9338f5dd93a05c21975ff91551a718880

See more details on using hashes here.

File details

Details for the file quick_flask_server-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: quick_flask_server-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for quick_flask_server-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8180cf90dfd094638eaf7af558c8616572595f1e307ccbe1c3ac5d41928463ea
MD5 1d50683bc29432aa06dbf90b023f019b
BLAKE2b-256 946e594cc028afd01ccfd554efe2b623e870b89a9577af7b8d138cfd3a9fb774

See more details on using hashes here.

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