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 StackItem itself. 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:
- items of the currently visible menu
- title of 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:
- heading of a headed menu
- sub_heading of a headed menu
- placeholder of 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:
- menu of 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.7.dev1241030103555355981015698

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ubo-gui 0.13.7.dev1241030103555355981015698
File	Size	Uploaded
ubo_gui-0.13.7.dev1241030103555355981015698.tar.gz	8.6 MB	Oct 30, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for ubo-gui 0.13.7.dev1241030103555355981015698
File	Interpreter	ABI	Platform	Reset
ubo_gui-0.13.7.dev1241030103555355981015698-py3-none-any.whl 8.6 MB Oct 30, 2024	Python 3	none	any	Details

Total release size: 17.2 MB

Release files / ubo_gui-0.13.7.dev1241030103555355981015698.tar.gz

Download URL	ubo_gui-0.13.7.dev1241030103555355981015698.tar.gz
Size	8.6 MB
Tags	Source
SHA-256 checksum How to use checksums	`d57dda63d3625848cd0dbb1b914f295dfb80ac24e2e867b9d1f3238dfb860beb`
BLAKE2b-256 checksum How to use checksums	`98124ad6de138acfbbae68d527ce5861920c509fc1c2273b562e8dd34a29603d`
Upload date	Oct 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ubopod/ubo-gui
Publishing commit: github.com/ubopod/ubo-gui/tree/757be8b11139c8973950e53c797289ea78a1c0bd

Workflow

Publishing configuration: github.com/ubopod/ubo-gui/blob/757be8b11139c8973950e53c797289ea78a1c0bd/.github/workflows/integration_delivery.yml
Publishing logs: github.com/ubopod/ubo-gui/actions/runs/11587900225/attempts/2

Artifact

Subject: ubo_gui-0.13.7.dev1241030103555355981015698.tar.gz
SHA-256 checksum: d57dda63d3625848cd0dbb1b914f295dfb80ac24e2e867b9d1f3238dfb860beb Verifying attestations

Release files / ubo_gui-0.13.7.dev1241030103555355981015698-py3-none-any.whl

Download URL	ubo_gui-0.13.7.dev1241030103555355981015698-py3-none-any.whl
Size	8.6 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`2a84bedf091112487ced4f62a2665420da2b7d246e50c812f6d682dac884a571`
BLAKE2b-256 checksum How to use checksums	`c552a05319c9fb5fab89bca853e7504094daca05958673ba4759fe926f9cb422`
Upload date	Oct 30, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.1.1 CPython/3.12.7`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/ubopod/ubo-gui
Publishing commit: github.com/ubopod/ubo-gui/tree/757be8b11139c8973950e53c797289ea78a1c0bd

Workflow

Publishing configuration: github.com/ubopod/ubo-gui/blob/757be8b11139c8973950e53c797289ea78a1c0bd/.github/workflows/integration_delivery.yml
Publishing logs: github.com/ubopod/ubo-gui/actions/runs/11587900225/attempts/2

Artifact

Subject: ubo_gui-0.13.7.dev1241030103555355981015698-py3-none-any.whl
SHA-256 checksum: 2a84bedf091112487ced4f62a2665420da2b7d246e50c812f6d682dac884a571 Verifying attestations