A simple way to demo Flask apps from your machine.
Project description
flask-ngrok-st
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-ngrok-st 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-ngrok-st
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
- Import with
from flask_ngrok_st 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_st 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
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.
Source Distribution
Built Distribution
Hashes for flask_ngrok_st-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3fe71ff967d4ade782646df58e4458510b2864b32d920a4a3d7a3957d713718 |
|
MD5 | 63862925614287d1d4fea7c38b8a8a6d |
|
BLAKE2b-256 | 6fd39a1c44c5b36c0d417eba64adf9dd53068a58f91e50c37d5cf6f336225e91 |