webappify/README.rst
Raoul Snyman 49fd14d7c2
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci/woodpecker/pr/woodpecker Pipeline was successful
ci/woodpecker/pull_request_closed/woodpecker Pipeline was successful
Update the README
2024-09-27 11:30:23 -05:00

1.7 KiB

WebAppify

pypi license build

WebAppify is a simple module to easily create your own desktop apps of websites. WebAppify uses PySide6 and QtWebEngine for displaying the web page, and works on Python 3.10 and up.

To create your own desktop web app, import and set up the WebApp class.

from webappify import WebApp

app = WebApp('OpenStreetMap', 'https://www.openstreetmap.org', 'osm.png')
app.run()

This will create a window with the website, using the icon provided.

Note

If your site needs Flash Player, you'll need the appropriate Flash Player plugin installed system-wide.

Additional Options

can_minimize_to_tray

Important

This option was changed in version 0.4.0 from canMinimizeToTray to can_minimize_to_tray. The old option is still available, but is deprecated. It will be removed in 0.6.0.

To install a system tray icon, and minimize your application to the system tray, simply pass can_minimize_to_tray=True to the class and a tray icon will be installed with the necessary menu options.

app = WebApp('OpenStreetMap', 'https://www.openstreetmap.org', 'osm.png', can_minimize_to_tray=True)

Clicking on the tray icon will show the window, while right-clicking will show the menu.