Skip to content

mmertama/Gempyre-Python

Repository files navigation

Gempyre-Python

The easy and productive UI library for Python.

If you know HTML, Gempyre is for you!

Gempyre

Gempyre is a C++ GUI library, see https://github.com/mmertama/Gempyre.git.

install from PyPi

There are many flavors in installing - but you need at least Python3.8 on Linux, Windows or MacOS.

e.g.

pip3 install Gempyre --user  

or using Poetry

poetry add Gempyre

Installs Gempyre to the current user site-packages.

See also Create a venv (https://docs.python.org/3/library/venv.html)

Build from sources

You can clone the repository and do install, or get releases from repository.

Gempyre-Python uses scikit build (some OS would need use python3 instead of python): python -m build && pip install -e .

Notes:

Raspberry OS

Todo: Needs optional RASPEBERRY flag to be passed to CMake.

Missing libraries

You may need python3-dev and python3-pip be installed. This may depend on your evironment, In linux e.g. apt-get install python3-dev, in MacOS look brew.

Build with scikit-build

python3 -m venv venv
source venv/bin/activate
pip3 install scikit-build
pip3 install .
python3 examples/balls/balls.py

Windows:

# Windows has a limit of path lengths to 260 chars - 8-+ 
#   
#   "260 characters is enough for everybody"
#                 - W.G III

Windows default filepath length is an issue. See Here and Here (reboot after change)

If that does not help (or not an option) you may try say in powershell.

mkdir C:\f
$env:TMPDIR = "C:\f"
$env:TEMP = "C:\f"

...before pip install.

Run

After install, you just run the script!

$ python3 test/telex_test.py

API

See examples how to use e.g. telex_test

The programming interface is very same as in Gempyre

  • except I changed function and method name naming from CamelCase to more pythonic snake_case (Im not sure if that was a right choice).

Please look Gempyre for documentation.

Please note that Gempyre Core and Gempyre Graphics are part of Python API, but not Gempyre-Utils, it has C++ utilites and thus not applicable for Python programmers as everything and more is already there!

Examples

See examples and demos

See small test apps

Minimum single file app

#!/usr/bin/python3
import Gempyre
import os
import sys
from Gempyre import resource

html = '''
<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" />
  <meta http-equiv="Pragma" content="no-cache" />
  <meta http-equiv="Expires" content="0" />
</head>
<body>
  <script src="/gempyre.js"></script>
  Hello!
</body>
</html>  
'''


if __name__ == "__main__":
    map, names = resource.from_bytes({"ui.html": bytes(html, 'utf-8')})
    ui = Gempyre.Ui(map, names["ui.html"])
    ui.run()
    

Minimum application with an external UI file

import Gempyre
import os
import sys
from Gempyre import resource

name = os.path.join(os.path.dirname(sys.argv[0]), "hello.html")
map, names = resource.from_file(name)
ui = Gempyre.Ui(map, names[name])
ui.run()

HTML

Assumed to be found in the same folder as the script

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
  </head>
  <body>
    <script src="/gempyre.js"></script>
    Hello!
  </body>
</html>

Application with interaction

Python

def main():
    name = os.path.join(os.path.dirname(sys.argv[0]), "example2.html")
    map, names = resource.from_file(name)
    ui = Gempyre.Ui(map, names[name])
    output = Gempyre.Element(ui, "output")
    open_button = Gempyre.Element(ui, "open")
    open_button.subscribe("click", lambda _: output.set_html("Hello"))
    ui.run()

if __name__ == "__main__":
    main()

HTML

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>test</title>
  </head>
  <body>
    <script src="/gempyre.js"></script>
    <button id="open">Open</button>
    <pre id="output"></pre>
  </body>
</html>