Metadata-Version: 2.1
Name: flask-ngrok
Version: 0.0.16
Summary: A simple way to demo Flask apps from your machine.
Home-page: https://github.com/gstaff/flask-ngrok
Author: Grant Stafford
License: UNKNOWN
Description: # flask-ngrok
        [![PyPI version](https://badge.fury.io/py/flask-ngrok.svg)](https://badge.fury.io/py/flask-ngrok)
        
        A simple way to demo Flask apps from your machine.
        Makes your [Flask](http://flask.pocoo.org/) apps running on localhost available
         over the internet via the excellent [ngrok](https://ngrok.com/) tool.
        
        ## Compatability
        Python 3.6+ is required.
        
        ## Installation
        
        ```bash
        pip install flask-ngrok
        ```
        ### Inside Jupyter / Colab Notebooks
        Notebooks have [an issue](https://stackoverflow.com/questions/51180917/python-flask-unsupportedoperation-not-writable) with newer versions of Flask, so force an older version if working in these environments.
        ```bash
        !pip install flask==0.12.2
        ```
        
        ## Quickstart
        1. Import with ```from flask_ngrok import run_with_ngrok```
        2. Add `run_with_ngrok(app)` to make your Flask app available upon running
        ```python
        # 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:
        ```bash
        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 
        ```
Keywords: flask ngrok demo
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
