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.6.dev124102910399515255545098.tar.gz.

File metadata

File hashes

Hashes for ubo_gui-0.13.6.dev124102910399515255545098.tar.gz
Algorithm Hash digest
SHA256 e70253da0db8cf5f55a7c1f15cc2f15ccfc224cbd330f27e446a30d6a4f1a6d0
MD5 92849ef0a47eebdd4894e5f9bb4f43a4
BLAKE2b-256 955a9b6092476342b864e93cadccaaf7c3da2972db8886a7616c795b1f145d58

See more details on using hashes here.

File details

Details for the file ubo_gui-0.13.6.dev124102910399515255545098-py3-none-any.whl.

File metadata

File hashes

Hashes for ubo_gui-0.13.6.dev124102910399515255545098-py3-none-any.whl
Algorithm Hash digest
SHA256 65db2c73346b402325f925a6d91312528ccd0b44b826ef66ba5916b141747e85
MD5 4b60ebf948d0392047fecd5783cf5851
BLAKE2b-256 1425c7b3d3ce8fea75baec3553b6ef03c0377f24a9b43b7b485639a3cb621be1

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