Skip to main content

A simple module for making HTML GUI applications with python3/asyncio

Project description

wuy

( You should consider GUY (when available)! )

If you have made a super python tool, and you want to add a GUI but without using qt/gtk/tk/wx/kivy/toga : you are in the right place ! Just re-use the local browser (chrome in app mode) as GUI, drived by wuy.


html / python

Basically, it's a python module which will act as a web server (http & websocket) and will open/manage a window for you ; providing a simple framework (js/py3 helpers).

It lets you create your GUI with yours web skills (html/js/css or any js frameworks/libs), and re-use the power of python on server side.

Technically, it's a python3 module, using asyncio and the marvellous aiohttp, and (if present) the uvloop, for the full speed ! The http server is here to serve static content (html, js, images ...). The websocket is here to simplify the communication (sync/async) between the window & the server. (rpc method to communicate from client to server, pubsub mechanism to communicate from server to clients, or from client to clients)

In app/window mode : it will manage (open/close) the window for you ; using the chrome app mode ; if the websocket brokes : window & server will shutdown (close the window ; the server will shutdown, close the server ; the window will shutdown). You (or your clients) will not see a difference with classical GUI !

In server mode : it will act as a classical web server ; and you can use as many clients/browsers as you want, from localhost or from anywhere else. Closing a socket ; just close the socket ;-). It can be hosted on the web, as long as the provider service use python3.

More on window/server differences

In all cases : it will be pretty easy to produce/freeze an executable (windows/linux/apple) (one file with all html/js embedded), using pyinstaller/windows. And share your super python tool to the world (wuy comes with its own freezer (a wuy app !))! And in the future : android !

Since 0.6; wuy provide a js method to proxify http requests, to avoid CORS troubles.

Since 0.9; wuy provide get/set methods on client/server side to store/retrieve key/value pairs in a json file on serverside.

It's, a little bit, the same thing as python eel.

TODOs:

  • In the future : cefpython3 will be the platform of choice for running wuy apps on android/iphone (when cef and cefpython3 will be ready). Currently wuy works with cefpython3, on linux/windows/apple. It's working in the unittests suite (you can already try ; modify wuy.py, replace ChromeApp() by ChromeAppCef())
  • Write docs & examples

The simplest example

This is the hello world of wuy

import wuy

class helloWorld(wuy.Window):
    """ <button onclick="wuy.beep()">BEEP</button> """
    size=(100,100)

    def beep(self):
        print("\a BEEP !!!")

helloWorld()

To Test/Run

Download the zip from here

$ pip3 install aiohttp winreg
$ python3 -u an_app.py

(winreg is needed for windows only)

It's an app !

For a regular server example (many clients from anywhere on web)

$ python3 -u a_server.py

To Use

Install the lib :

$ pip3 install wuy winreg

(winreg is needed for windows only)

And follow the official tuto.

See Examples

  • an_app : all kind of tricks
  • an_app2 : an input box
  • an_app3 : an alert box with autodeclared js vars (chain'able windows)!
  • an_app4 : using sync & async rpc calls !
  • an_app5 : using async aiohttp.get (request content from web) & FULLSCREEN mode
  • an_app6 : progress bars (async)
  • an_app7 : html is inside the docstring ! (SIMPLEST)
  • an_app8 : just to show how to organize your code when app's expand.
  • an_appVuejs : using a vuejs app (and a continuous push from server to client)
  • a_server : a server, tchat service for multiple clients
  • an_upload : a drag'n'drop upload to server example.

Don't forget to have a look at real examples too (real apps for real life)

A big real life app : See jBrout3 (in development), it's the rebirth of the good old py2/gtk app : jBrout2. It use vuejs/vuex for front, and the jbrout's lib to manage photos.

Doc

Use wuy.Window for app (which open/manage a chrome window app)

Use wuy.Server for classic http/ws servers

And client side (javascript), in all cases : use wuy.js

Learn More on differences between this two class

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wuy, version 0.10.1
Filename, size File type Python version Upload date Hashes
Filename, size wuy-0.10.1-py3-none-any.whl (50.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size wuy-0.10.1.tar.gz (21.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page