Skip to main content

GUI sdk for Ubo Pod

Project description

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file ubo_gui-0.13.5.dev2241029103555452505210252.tar.gz.

File metadata

File hashes

Hashes for ubo_gui-0.13.5.dev2241029103555452505210252.tar.gz
Algorithm Hash digest
SHA256 d807d02f41463f2dabc66d0afd004145ecdf273c9d0a20065d9aaa6576e74b4f
MD5 f5b39cbbd2908b1f3740c1f493b12405
BLAKE2b-256 f19881cdffb6bb8bdc0008a41b5bb518bd54a64bcad3395d8100a9f18b1701bb

See more details on using hashes here.

File details

Details for the file ubo_gui-0.13.5.dev2241029103555452505210252-py3-none-any.whl.

File metadata

File hashes

Hashes for ubo_gui-0.13.5.dev2241029103555452505210252-py3-none-any.whl
Algorithm Hash digest
SHA256 a23db5681df75d30cc3448b24bf3c0d0081a5b53e80536856a2682b75d904f9d
MD5 dea7be212109e05df51f22a7288643c7
BLAKE2b-256 3b27fdfa7543fef5a01654ba901beb458bbb7f64b1a5ad0b23a60387181d8e0b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page