Python bindings for Sciter
Python
Latest commit 4ad1e76 Oct 25, 2016 @pravic version 0.4.5

README.md

Python bindings for Sciter

Join the chat at https://gitter.im/pravic/pysciter

Check this page for another language bindings.


Sciter is an embeddable multiplatform HTML/CSS/script engine with GPU accelerated rendering designed to render modern desktop application UI. It's a compact, single dll/dylib/so file (4-8 mb), engine without any additional dependencies.

Check the screenshot gallery of the desktop UI examples.

Physically Sciter is a mono library which contains:

Internally it contains the following modules:

  • CSS – CSS parser and collection of parsed CSS rules, etc.
  • HTML DOM – HTML parser and DOM tree implementation.
  • layout managers – collection of various layout managers – text layout, default block layout, flex layouts. Support of positioned floating elements is also here. This module does layout calculations heavy lifting. This module is also responsible for rendering of layouts.
  • input behaviors – collection of built-in behaviors – code behind "active" DOM elements: <input>, <select>, <textarea>, etc.
  • script module – source-to-bytecode compiler and virtual machine (VM) with compacting garbage collector (GC). This module also contains runtime implementation of standard classes and objects: Array, Object, Function and others.
  • script DOM – runtime classes that expose DOM and DOM view (a.k.a. window) to the script.
  • graphics abstraction layer – abstract graphics implementation that isolates modules above from particular platform details
    • Direct2D/DirectWrite graphics backend implementation (Windows);
    • GDI+ graphics backend implementation (Windows);
    • CoreGraphics backend implementation (Mac OS X);
    • Cairo backend implementation (GTK on all platforms including Linuxes);
  • core primitives – set of common primitives: string, arrays, hash maps and so on.

Sciter supports all standard elements defined in HTML5 specification with some additions. CSS extended to better support Desktop UI development, e.g. flow and flex units, vertical and horizontal alignment, OS theming.

Sciter SDK comes with demo "browser" with builtin DOM inspector, script debugger and documentation browser:

Sciter tools

Check http://sciter.com website and its documentation resources for engine principles, architecture and more.

Getting started:

Right now, before PySciter will not be published on PYPI

  1. Download Sciter SDK and extract it somewhere.
  2. Add target platform binaries to PATH (bin, bin.osx or bin.gtk) and install Sciter shared library to your LIBRARY_PATH.
  3. Install pysciter: python3 setup.py install or pip install pysciter.
  4. Run minimal pysciter sample: python3 examples/minimal.py. Also you can run script from zip archive directly: python3 ./archive.zip :)

Brief look:

Minimal sciter app is extremely small:

import sciter

if __name__ == '__main__':
    frame = sciter.Window(ismain=True, uni_theme=True)
    frame.load_file("minimal.htm")
    frame.expand()
    frame.run_app()

It looks similar like this:

Minimal pysciter sample

Interoperability

In respect of tiscript functions calling:

answer = self.call_function('script_function', "hello, python!", "and", ["other", 3, "arguments"])

Calling python from script can be implemented as following:

def GetNativeApi(): # called from sciter.EventHandler.on_script_call
  def on_add(a, b):
      return a + b

  def on_sub(a, b):
      raise Exception("sub(%d,%d) raised exception" % (a, b))

  api = { 'add': on_add,  # plain function
          'sub': on_sub,  # raise exception at script
          'mul': lambda a,b: a * b }   # lambdas supported too
  return api

So, we can access our api now:

// `view` represents window where script is runnung.
// `stdout` stream is a standard output stream (shell or debugger console, for example)

var api = view.GetNativeApi();

// returned `api` object looks like {add: function(a,b) { return a + b; }};
stdout.println("2 + 3 = " + api.add(2, 3));

Check pysciter/examples folder for more complex usage.

What supported right now:

  • sciter::window which brings together window creation, host and event handlers
  • sciter::host extensible implementation with transparent script calls from python code
  • sciter::event_handler with basic event handling (attached, document_complete, on_script_call), additional handlers will come
  • sciter::dom for HTML DOM access and manipulation methods
  • sciter::value pythonic wrapper with sciter::script_error and sciter::native_function support
  • sciter::behavior_factory - global factory for native behaviors
  • sciter::graphics - platform independent graphics native interface (can be used in native behaviors)
  • sciter::request - resource request object, used for custom resource downloading and handling
  • sciter::video - custom video rendering
  • sciter::archive - Sciter's compressed archive produced by sdk/bin/packfolder

Platforms:

  • Windows
  • OSX
  • Linux

Python 3.x (2.7 in near future).

License

Bindings library licensed under MIT license. Sciter Engine has the own license terms and end used license agreement for SDK usage.