Skip to content

Dev Guide

New features

All pull requests are welcome. Let's make script creation a better experience together. Alongside code base change, modify:

If adding a dependency, make sure to reflect that in pyproject.toml and in README.md install section.

Interface architecture

Every interface has several uniform objects:

  • Mininterface: front-end for the programmer. Easy to use and uniform methods.
  • Adaptor: Connection point. Public attributes not meant to be used by the (end-user) programmer.
  • App (optional): External library UI handler. (Like tkinter.)
  • Facet: Layout definition.
graph LR
dataclass --> Tags --> Mininterface --> Adaptor --> App
Adaptor --> Facet
Facet --> Tags

Adaptor

mininterface.mininterface.adaptor.BackendAdaptor

Connection point between a Mininterface and an external UI library.

widgetize(tag)

Wrap Tag to a UI widget.

run_dialog(form, title='', submit=True)

Let the user edit the dict values.

Setups the facet._fetch_from_adaptor.