WKApp index.html placeholder

First view Test View Exit Application

Overview

WKApp is a modern, lightweight and minimal application framework for developing Python applications with desktop-class HTML 5 user interfaces on Apple iOS devices in the Pythonista 3 IDE. It provides a simple basis to start creating browser based applications in Pythonista quickly while offering wide customisability capable of developing from simple single page applications through to sophisticated multi-view mobile applications supporting anything you can do in HTML 5 with WebKit support including canvases, browser gaming, media playback, file editing and more. Use any Python libraries from the pip ecosysten that can be installed and supported by Pythonista. And/or use any WebKit/Safafi in browser compatible javascript for client side functionality too. Supporting bi-directional and asyncronous interop between both, Python and JavaScript can work together to produce compelling experiences. Handling styling of your application and concerns like device orientation, screen size and scaling in the same way as any other responsive website using css's powerful, mature and well known feature set. Web frontend libraries Bootstrap 5, for out of the box responsive styling, and JQuery, to ease, extend and perform DOM manipulation, are bundled to help streamline, and give options focused on rapidly developing apps, instead of getting lost down areas such as drawing an apps ui more traditionally for example. The whole of the included base app ui templates and static files are however also customiable and replacable too, so these may be overriden, removed or expanded with plugins etc depending on your applications requirements and needs.

Python Dependencies

• Bottle.py 0.13.4
• Mako 1.13.10
• WKWebView 1.2 (Bundled)
  • 1.2 is a customised extended version which has been updated for WKApp, to implement displaying apps in UIKits WKWebView WebKit browser control. Changes consist mostly of fixes, improvments to reliability, simplifying threading concerns, avoiding/removing the odd crash and deadlock in handling objective-c, python, js interactions here and there and adding a few more helper methods.
  • 1.1 - Gist (@sbbosco)
  • 1.0 - Github (@mikaelho)

Bundled Web frontend libraries:

• JQuery 3.7.1
• Bootstrap 5.3.8

Getting started

First, create your app.py file, the bare minimum code to setup, run and display a WKApp is just three lines as follows. app.py ${codeblock(''' from wkapp import * app = WKApp(__file__) app.run() ''')}

When you run this file in Pythonista you should see this page! To create your own make a new file views/index.html, which will then replace this document as the placeholder being shown in your apps main view and re-run: ${codeblock(''' <%inherit file="view.html"/>

''')} Congratulations! You've just created a WKApp HTML 5 browser based app on your iOS device. Now, you may already be wanting to try some more things out, go right ahead any html/css/javascript should just work. The following is a small overview of some of WKApp features and how they are integrated with Bottle.py as for hosting the WSGI web server for the app and the Mako template engine for rendering pages, components and content from templates with a rich, comprehensive syntax using interweaved Python which can generate html markup, styles and even javascript dynamically.

Features

Views are served automatically without wire-up and can be navigated as normal web pages, just drop in html templates into the `./views` folder. ${codeblock(''' <%inherit file="view.html"/>

<%inherit file="view.html"/> ''')} Add python behavior to views with inline class mixins, manipulate elements, receive lifecycle events and hold custom page state. ${codeblock(''' <%! class IndexView: def on_init(self): self.editor = self.element('editor') def hello_world_action(self, text): print(text) cur = self.editor.get('text') print(cur) self.editor.set('text',cur + text) view_class = IndexView %> <%inherit file="view.html"/> ''')} You can define any scheme and custom routes, middleware and handlers may also be added with any constructs supported by Bottle.py. app.py ${codeblock(''' from wkapp import * app = WKApp(__file__) app.run() # see https://bottlepy.org/docs/dev/tutorial.html#generating-content for more examples @route('/my/route') def my_route(): return "Hello World!" ''')}