flask-localtunnel


Nameflask-localtunnel JSON
Version 1.0.7 PyPI version JSON
download
home_pagehttps://github.com/redevil1/flask-localtunnel
SummaryA simple way to demo Flask apps from your machine.
upload_time2024-04-27 15:44:22
maintainerNone
docs_urlNone
authorJak Bin
requires_pythonNone
licenseNone
keywords flask flask-ngrok ngrok localtunnel demo
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # flask-localtunnel

 [![PyPI version](https://badge.fury.io/py/flask-localtunnel.svg)](https://badge.fury.io/py/flask-localtunnel)
 [![Downloads](https://pepy.tech/badge/flask-localtunnel/month)](https://pepy.tech/project/flask-localtunnel)
 [![Downloads](https://static.pepy.tech/personalized-badge/flask-localtunnel?period=total&units=international_system&left_color=green&right_color=blue&left_text=Total%20Downloads)](https://pepy.tech/project/flask-localtunnel)
 ![Python 3.6](https://img.shields.io/badge/python-3.6-yellow.svg)

### This inspired from flask-ngrok


### Disclaimer:-
Use it only for educational purpose.


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 [localtunnel](https://github.com/localtunnel/localtunnel) tool.

## Compatability
Python 3.6+ is required.

## Installation

```bash
pip install flask-localtunnel
```
### Inside Jupyter / Colab Notebooks

```bash
!pip install flask
```

## Quickstart
1. Import with ```from flask_localtunnel import run_with_lt```
2. Add `run_with_lt(app)` to make your Flask app available upon running
```python
# flask_ngrok_example.py
from flask import Flask
from flask_lt import run_with_lt

app = Flask(__name__)
run_with_lt(app)

@app.route("/")
def hello():
    return "Hello World!"

if __name__ == '__main__':
    app.run()
```
Running the example:
```bash
python flask_lt_example.py
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * localtunnel is alreadty installed.
 * your url is: https://<random-url>.loca.lt
```

### Support my work :-

BTC - bc1qx2p08qtsxxdzj0yfr2cm7yy3g5ydv3mt2753le\
ETH - 0x40e69DaEC18cD199535b055BDA6582daa5978145

### Contributer :- 
- @henk717
- @NobreHD : subdomain support 

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/redevil1/flask-localtunnel",
    "name": "flask-localtunnel",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "flask, flask-ngrok, ngrok, localtunnel, demo",
    "author": "Jak Bin",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# flask-localtunnel\n\n [![PyPI version](https://badge.fury.io/py/flask-localtunnel.svg)](https://badge.fury.io/py/flask-localtunnel)\n [![Downloads](https://pepy.tech/badge/flask-localtunnel/month)](https://pepy.tech/project/flask-localtunnel)\n [![Downloads](https://static.pepy.tech/personalized-badge/flask-localtunnel?period=total&units=international_system&left_color=green&right_color=blue&left_text=Total%20Downloads)](https://pepy.tech/project/flask-localtunnel)\n ![Python 3.6](https://img.shields.io/badge/python-3.6-yellow.svg)\n\n### This inspired from flask-ngrok\n\n\n### Disclaimer:-\nUse it only for educational purpose.\n\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 [localtunnel](https://github.com/localtunnel/localtunnel) tool.\n\n## Compatability\nPython 3.6+ is required.\n\n## Installation\n\n```bash\npip install flask-localtunnel\n```\n### Inside Jupyter / Colab Notebooks\n\n```bash\n!pip install flask\n```\n\n## Quickstart\n1. Import with ```from flask_localtunnel import run_with_lt```\n2. Add `run_with_lt(app)` to make your Flask app available upon running\n```python\n# flask_ngrok_example.py\nfrom flask import Flask\nfrom flask_lt import run_with_lt\n\napp = Flask(__name__)\nrun_with_lt(app)\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_lt_example.py\n * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n * localtunnel is alreadty installed.\n * your url is: https://<random-url>.loca.lt\n```\n\n### Support my work :-\n\nBTC - bc1qx2p08qtsxxdzj0yfr2cm7yy3g5ydv3mt2753le\\\nETH - 0x40e69DaEC18cD199535b055BDA6582daa5978145\n\n### Contributer :- \n- @henk717\n- @NobreHD : subdomain support \n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple way to demo Flask apps from your machine.",
    "version": "1.0.7",
    "project_urls": {
        "Homepage": "https://github.com/redevil1/flask-localtunnel"
    },
    "split_keywords": [
        "flask",
        " flask-ngrok",
        " ngrok",
        " localtunnel",
        " demo"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d26d1aa24d1be4e530bac07cd0d7d525b483dfe7fe2b8b4101d1eef79ba0bfd6",
                "md5": "47566e48c7f42337a4bdd6ab0792e510",
                "sha256": "8f2bde197ec545bbd7ef0df8cdf7d4facb5bfe77458a140d5bc92f788eba306e"
            },
            "downloads": -1,
            "filename": "flask_localtunnel-1.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "47566e48c7f42337a4bdd6ab0792e510",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3116,
            "upload_time": "2024-04-27T15:44:22",
            "upload_time_iso_8601": "2024-04-27T15:44:22.749950Z",
            "url": "https://files.pythonhosted.org/packages/d2/6d/1aa24d1be4e530bac07cd0d7d525b483dfe7fe2b8b4101d1eef79ba0bfd6/flask_localtunnel-1.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-27 15:44:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "redevil1",
    "github_project": "flask-localtunnel",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "flask-localtunnel"
}
        
Elapsed time: 0.22203s