Create desktop applications with Flask/Django/FastAPI!
Project description
Create desktop applications with Flask/FastAPI/Django!
Install
pip install flaskwebgui
Or download source file flaskwebgui.py and place it where you need.
Usage with Flask
Let's say we have the following flask application:
#main.py
from flask import Flask
from flask import render_template
from flaskwebgui import FlaskUI # import FlaskUI
app = Flask(__name__)
ui = FlaskUI(app, width=500, height=500) # add app and parameters
@app.route("/")
def hello():
return render_template('index.html')
@app.route("/home", methods=['GET'])
def home():
return render_template('some_page.html')
if __name__ == "__main__":
# app.run() for debug
ui.run()
Alternatively, next to main.py
create a file called gui.py
and add the following contents:
#gui.py
from flaskwebgui import FlaskUI
from main import app
FlaskUI(app, width=600, height=500).run()
Next start the application with:
python main.py
#or
python gui.py #in case you created gui.py
Application will start chrome in app mode, flask will be served by waitress
.
Usage with Flask-SocketIO
Let's say we have the following SocketIO application:
#main.py
from flask import Flask
from flask_socketio import SocketIO
from flaskwebgui import FlaskUI
app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)
@app.route("/")
def index():
return {"message": "flask_socketio"}
if __name__ == '__main__':
# socketio.run(app) for development
FlaskUI(app, socketio=socketio).run()
Alternatively, next to main.py
create a file called gui.py
and add the following contents:
#gui.py
from flaskwebgui import FlaskUI
from main import app, socketio
FlaskUI(app, socketio=socketio).run()
Next start the application with:
python main.py
#or
python gui.py #in case you created gui.py
Application will start chrome in app mode, flask will be served by socketio
.
Usage with FastAPI
Pretty much the same, bellow you have the main.py
file:
from fastapi import FastAPI
from flaskwebgui import FlaskUI # import FlaskUI
app = FastAPI()
ui = FlaskUI(app) # feed app and parameters
@app.get("/")
def read_root():
return {"message": "Works with FastAPI also!"}
if __name__ == "__main__":
ui.run()
Alternatively, next to main.py
create a file called gui.py
and add the following contents:
#gui.py
from flaskwebgui import FlaskUI
from main import app
FlaskUI(app, width=600, height=500).run()
Next start the application with:
python main.py
#or
python gui.py #in case you created gui.py
Fastapi will be served by uvicorn
.
Usage with Django
Next to manage.py
file create a gui.py
file where you need to import application
from project's wsgi.py
file.
#gui.py
from flaskwebgui import FlaskUI
from project_name.wsgi import application
FlaskUI(application).run()
Next start the application with:
python gui.py
Django will be served by waitress
.
Configurations
Default FlaskUI class parameters:
-
app, ==> flask class instance
-
width=800 ==> default width 800
-
height=600 ==> default height 600
-
fullscreen=False ==> start app in fullscreen
-
maximized=False ==> start app in maximized window
-
app_mode=True ==> by default it will start chrome in app(desktop) mode without address bar
-
browser_path="" ==> path to
browser.exe
(absolute path to chromeC:/browser_folder/chrome.exe
) -
start_server="flask" ==> You can add a function which starts the desired server for your choosed framework (bottle, web2py pyramid etc)
-
port=5000 ==> specify other if needed
-
socketio=SocketIO Instance ==> Flask SocketIO instance (if specified, uses
socketio.run()
instead ofapp.run()
for Flask application)
Should work on windows/linux/mac with no isssues.
Develop your app as you would normally do, add flaskwebgui at the end or for tests. flaskwebgui doesn't interfere with your way of doing a flask application it just helps converting it into a desktop app more easily with pyinstaller or pyvan.
Distribution
You can distribute it as a standalone desktop app with pyinstaller or pyvan.
Credits
It's a combination of https://github.com/Widdershin/flask-desktop and https://github.com/ChrisKnott/Eel
flaskwebgui just uses threading to start a flask server and the browser in app mode (for chrome). It has some advantages over flask-desktop because it doesn't use PyQt5, so you won't have any issues regarding licensing and over Eel because you don't need to learn any logic other than Flask/Django.
Submit any questions/issues you have! Fell free to fork it and improve it!
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
File details
Details for the file flaskwebgui-0.2.0.tar.gz
.
File metadata
- Download URL: flaskwebgui-0.2.0.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | aedd910c013a4e0d21790421a25d131604510bed673fe4f355c454cdf876cecd |
|
MD5 | a17dc4fdc38a9114b3efacac5c983af1 |
|
BLAKE2b-256 | 722845a2d1746518bf0231d0170a8d1e6d3bd6ed632432688bbbdb3b870f6be5 |
File details
Details for the file flaskwebgui-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: flaskwebgui-0.2.0-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d819c185bdc1072e3c6fb1183bb49e9fa357358d73ecd48decb95cce4a6e4090 |
|
MD5 | 377c482d44bca96455f110ead23134b2 |
|
BLAKE2b-256 | c8abfbd410eac3f8cbe2dadb073eb298b2c76a781a1239b26ad91a765a15c429 |