Readme
A simple to use GUI framework for python. You define what you want and the framework does the rest. You build the UI out of components that are defined using XML as markup language. The markup language allows you to interact with your python code via variable binding, callbacks and the use of control flow primitives. To help you with organizing your application, the framework allows you to nicely compose components and comes with automated dependency injection. (You know vue.js or angular from web development? Something like that.)
Ever wondered why so many GUIs nowadays seem to be written with a HTTP/CSS/JS front end, even for desktop (e.g. via electron)? How is that the easiest way of designing modern GUIs? Some things in web front end development are nice and shiny, like live inspection and editing of styles, reactive variable bindings, defining components and the UI in a nice markup language, allow control flow in the markup language, have automatic dependency injection...
Can't we have all these nice things but in python? And without the hassle of a client-server architecture and java script?
This project is a case study where I try to figure out and build the GUI framework that I would want to use. To not have to deal with legacy issues of other GUI frameworks, this project starts quite low level using pyglet as window engine and to deal with IO, cairo for drawing and pango for text setting and librsvg for svg drawing. Everything else is build from scratch.
The current state is a proof of concept. It should work on the examples, but is other wise terribly tested, barely documented and probably throws non-sensical error messages at you when you do something wrong. The API is unstable.
The dokumentation and a small tutorial can be found at guiml.readthedocs.io.
Install external requirenments (to access librsvg, cairo, pango from python)
sudo apt install librsvg2-dev libcairo2-dev python3-gi-cairo
cd guiml
pip install -r requirements.txt
If you run into problems with installing the dependencies, you can check out the links in the Other section below.
For Windows it is recommended to use Debian on WSL2 (Instructions) once on the Debian command line you can follow the normal Debian instructions for installing this package.
If you are not on a debian derivate, then installation should in principle be possible if you are sufficiently brave and smart, but you will have to figure it out yourself. Here are some links to the dependencies that might be helpfull.
You will need pygobject with cairo and librsvg.
Check how to install cairocffi and pangocffi on their respective sites.
Once the dependencies are installed you should be able to run the examples after installing the python dependencies
pip install -r requirements.txt
python3 -m examples.todolist
If you want to use guiml for your own project you can install it directly via
pip install .
It is recommended to use the latest version of pip and setuptools.
pip install -U pip setuptools
You can install the project from source via
git clone https://github.com/StephanGocht/guiml.git
cd guiml
pip install -e .
After installation (or just installing the packages from requirements.txt) you can run the examples from the guiml folder to confirm everything is working. For the todo list example run
python3 -m examples.todolist
To update to the latest version, run
git pull
tbd.
You can use find . -name LICENSE to collect all used licenses. The license
applies to all files in the contained directory or subdirectories.(Except for
directories that have their own LICENSE). Which should currently be as
follows.
./LICENSE (MIT)
./guimlcomponents/base/cairocffi_to_pycairo/LICENSE (BSD-3)
./examples/todolist/resources/material-design-icons/LICENSE (Apache-2)
Examples are not included in builds.
You can find more boradly used GUI frameworks on awesome-python.
See also:
Write your Python interfaces in a declarative manner with plain render functions, component classes or even single-file components using Vue-like syntax, but with Python!
FAQs
An xml based GUI framework with property binding and dependency injection.
We found that guiml demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.