flask-ngrok

Name	flask-ngrok JSON
Version	0.0.25 JSON
	download
home_page	https://github.com/gstaff/flask-ngrok
Summary	A simple way to demo Flask apps from your machine.
upload_time	2018-09-09 19:48:39
maintainer
docs_url	None
author	Grant Stafford
requires_python
license
keywords	flask ngrok demo
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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 
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gstaff/flask-ngrok",
    "name": "flask-ngrok",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "flask ngrok demo",
    "author": "Grant Stafford",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/1e/41/43e7bdcc4dac453b927feff5e0c9e30f8d34ef46c19fa320256893926893/flask-ngrok-0.0.25.tar.gz",
    "platform": "",
    "description": "# flask-ngrok\n[![PyPI version](https://badge.fury.io/py/flask-ngrok.svg)](https://badge.fury.io/py/flask-ngrok)\n\nA simple way to demo Flask apps from your machine.\nMakes your [Flask](http://flask.pocoo.org/) apps running on localhost available\n over the internet via the excellent [ngrok](https://ngrok.com/) tool.\n\n## Compatability\nPython 3.6+ is required.\n\n## Installation\n\n```bash\npip install flask-ngrok\n```\n### Inside Jupyter / Colab Notebooks\nNotebooks 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.\n```bash\n!pip install flask==0.12.2\n```\n\n## Quickstart\n1. Import with ```from flask_ngrok import run_with_ngrok```\n2. Add `run_with_ngrok(app)` to make your Flask app available upon running\n```python\n# flask_ngrok_example.py\nfrom flask import Flask\nfrom flask_ngrok import run_with_ngrok\n\napp = Flask(__name__)\nrun_with_ngrok(app)  # Start ngrok when app is run\n\n@app.route(\"/\")\ndef hello():\n    return \"Hello World!\"\n\nif __name__ == '__main__':\n    app.run()\n```\nRunning the example:\n```bash\npython flask_ngrok_example.py\n * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n * Running on http://<random-address>.ngrok.io\n * Traffic stats available on http://127.0.0.1:4040 \n```\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A simple way to demo Flask apps from your machine.",
    "version": "0.0.25",
    "split_keywords": [
        "flask",
        "ngrok",
        "demo"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0a57d47e259f2662059ff6393b919020",
                "sha256": "724519a4dd3a2d374af50d4c0c21a26548737de0cf23f68dfb8d3b31c7311e93"
            },
            "downloads": -1,
            "filename": "flask_ngrok-0.0.25-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0a57d47e259f2662059ff6393b919020",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3052,
            "upload_time": "2018-09-09T19:48:38",
            "upload_time_iso_8601": "2018-09-09T19:48:38.399887Z",
            "url": "https://files.pythonhosted.org/packages/af/6c/f54cb686ad1129e27d125d182f90f52b32f284e6c8df58c1bae54fa1adbc/flask_ngrok-0.0.25-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e9670cbdba10bc6314b2e129b3068dc1",
                "sha256": "3f8ec704ab54b981c08d7044702f2b46023bafc4958bfeb7cbc1a905fde6ef8d"
            },
            "downloads": -1,
            "filename": "flask-ngrok-0.0.25.tar.gz",
            "has_sig": false,
            "md5_digest": "e9670cbdba10bc6314b2e129b3068dc1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2744,
            "upload_time": "2018-09-09T19:48:39",
            "upload_time_iso_8601": "2018-09-09T19:48:39.572612Z",
            "url": "https://files.pythonhosted.org/packages/1e/41/43e7bdcc4dac453b927feff5e0c9e30f8d34ef46c19fa320256893926893/flask-ngrok-0.0.25.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2018-09-09 19:48:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "gstaff",
    "github_project": "flask-ngrok",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "flask-ngrok"
}