This release is a pre-release and may not be stable for production use.
Ubo GUI
GUI sdk for Ubo Pod
📋 Requirements
📦 Installation
You can install it using this handle: headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git
# pip:
pip install headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git
# poetry:
poetry add headless-kivy-pi@git+https://github.com/ubopod/ubo-gui.git
🛠 Usage
Checkout Ubo App to see a sample implementation.
🤝 Contributing
You need to have Poetry installed on your machine.
To install poetry in Raspbian you need to follow these instructions to install rust compiler, this is temporary until this issue is resolved:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
sudo apt-get install pkg-config libssl-dev
curl -sSL https://install.python-poetry.org | python3 -
After having poetry, to install the required dependencies, run the following command:
poetry install --with dev
Also be aware of this issue and until it is resolved you can manually disable keyring by prefixing your poetry commands like this:
PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring poetry install
You can run linter over whole codebase by running this command:
poetry run poe lint
Subscriptions
The subscriptions are divided into three groups:
- Screen subscriptions are those assigned to a particular stack item, but their handlers doesn't change anything in the
StackItemitself. The handler just changes something on the rendered screen and if that stack item is not visible, the handler doesn't need to be called. Therefore these subscriptions are cleared when the current screen is changed. Samples:itemsof the currently visible menutitleof the currently visible screen
- Menu subscriptions are those assigned to a particular menu. Like screen subscriptions, they are cleared when the current screen is changed. They also get cleared when the menu is scrolled.
Samples:
headingof a headed menusub_headingof a headed menuplaceholderof a menu
- Stack item subscriptions are those assigned to a particular stack item. They are cleared when the stack item is popped. They stay alive as long as the stack item is in the stack, even if it is in the background.
In other words, unlike the other two, they are not cleared when, for example, a sub-menu or an application is opened on top of the current stack item.
Samples:
menuof an item
⚠️ Important Note
Make sure to run poetry run poe download_font to download Material Symbols font.
🔒 License
This project is released under the Apache-2.0 License. See the LICENSE file for more details.
Metadata
Release files for ubo-gui 0.13.6.dev224102910355501009798100100
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ubo_gui-0.13.6.dev224102910355501009798100100.tar.gz | 8.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ubo_gui-0.13.6.dev224102910355501009798100100-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.2 MB
Release files / ubo_gui-0.13.6.dev224102910355501009798100100.tar.gz
| Download URL | ubo_gui-0.13.6.dev224102910355501009798100100.tar.gz |
|---|---|
| Size | 8.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e5becc4138c5b97ab2ee6ccf1d8f2e022fd83be83decb91ad2613a131ae2faaf
|
|
BLAKE2b-256 checksum How to use checksums |
256757db0436645d49f17902d8f97ea1aa9976160c1512acb044675357c707ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Release files / ubo_gui-0.13.6.dev224102910355501009798100100-py3-none-any.whl
| Download URL | ubo_gui-0.13.6.dev224102910355501009798100100-py3-none-any.whl |
|---|---|
| Size | 8.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f51308f9c359bea2c7d926aaa2e029d3257e25c466d626d8f4531b65ec095a15
|
|
BLAKE2b-256 checksum How to use checksums |
383d21f22bc991ff193fce8644cd22425901a2918141c930a8ee24b945f99c25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
