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.dev1241029103535456511005356.tar.gz.

File metadata

File hashes

Hashes for ubo_gui-0.13.5.dev1241029103535456511005356.tar.gz
Algorithm Hash digest
SHA256 6a064fef73737463564ba7b15c5b5528b4fcf9092e9e71d4dc900677212d7c50
MD5 cfa54346d1e74000ee3a57de715fe7a3
BLAKE2b-256 d7662a016deec211e5b68e39d86fd11263898def021c1013654935e1d358e18b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ubo_gui-0.13.5.dev1241029103535456511005356-py3-none-any.whl
Algorithm Hash digest
SHA256 b641dbcf9b17da6dd5ad41ef65824cfd732bc448f00f18c7284a74c5ee73aba8
MD5 2f05123facb049e4fa4920c5a5020751
BLAKE2b-256 bc418dab3b88bd13bf8a9e1b846ebd6ffd282c7ae2939b2850d38417da24126d

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