Skip to main content

Ubo main app, running on device initialization. A platform for running other apps.

Project description

🚀 Ubo App

image image image Actions status codecov

🌟 Overview

Ubo App is a Python application for managing Raspberry Pi utilities and UBo-specific features.

⚙️ Features

[To be written]

📋 Requirements

These things are already taken care of in the official Ubo Pod image, so if you are botting from that image, you can ignore this section.

  • Python 3.9 or later.
  • Run raspi-config -> Interface Options -> Enable SPI

📦 Installation

Note that as part of the installation process, these debian packages are installed:

  • git
  • i2c-tools
  • libcap-dev
  • libegl1
  • libgl1
  • libmtdev1
  • libzbar0
  • python3
  • python3-dev
  • python3-libcamera
  • python3-alsaaudio
  • python3-picamera2
  • python3-pip
  • python3-pyaudio
  • python3-virtualenv

Also be aware that ubo-app only installs in /opt/ubo and it is not customizable at the moment.


⚠️ Executing scripts directly from the internet with root privileges poses a significant security risk. It's generally a good practice to ensure you understand the script's content before running it. You can check the content of this particular script here before running it.


To install ubo, run this command in a terminal shell:

curl -sSL https://raw.githubusercontent.com/ubopod/ubo-app/main/ubo_app/system/install.sh\
  | sudo bash

If you want to install docker service and configure ubo to be able to use it run this:

curl -sSL https://raw.githubusercontent.com/ubopod/ubo-app/main/ubo_app/system/install.sh\
  | sudo WITH_DOCKER=true bash

To allow the installer to install the latest alpha version of ubo run this:

curl -sSL https://raw.githubusercontent.com/ubopod/ubo-app/main/ubo_app/system/install.sh\
  | sudo ALPHA=true bash
# or
curl -sSL https://raw.githubusercontent.com/ubopod/ubo-app/main/ubo_app/system/install.sh\
  | sudo ALPHA=true WITH_DOCKER=true bash

🤝 Contributing

Contributions following Python best practices are welcome.

ℹ️️ Conventions

  • Use UBO_ prefix for environment variables.
  • Use ubo: prefix for notification ids used in ubo core and <service_name>: prefix for notification ids used in services.
  • Use ubo: prefix for icon ids used in ubo core and <service_name>: prefix for icon ids used in services.

🔒 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

ubo_app-0.11.2.tar.gz (408.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ubo_app-0.11.2-py3-none-any.whl (436.5 kB view details)

Uploaded Python 3

File details

Details for the file ubo_app-0.11.2.tar.gz.

File metadata

  • Download URL: ubo_app-0.11.2.tar.gz
  • Upload date:
  • Size: 408.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ubo_app-0.11.2.tar.gz
Algorithm Hash digest
SHA256 08503316de140b09d0ef4a5d88064bfa6c467c97a92f5717fa81c76454aeab89
MD5 caf075cecac2e1f638d2245a9566fe69
BLAKE2b-256 9eae7fb39e360aa0353179c2eb50fdb5602eff406ac3cac7de15022c2f822375

See more details on using hashes here.

File details

Details for the file ubo_app-0.11.2-py3-none-any.whl.

File metadata

  • Download URL: ubo_app-0.11.2-py3-none-any.whl
  • Upload date:
  • Size: 436.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for ubo_app-0.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 537793a4419405e21ece5ddf1d654a27c3c504db731c5d9f2b5bf8a773641db7
MD5 1eb1d4125b6a2919a49bb81835c1cc9e
BLAKE2b-256 adcced3ec9b3843e0e65490675f3282c55f95aea792e81ca47a1c28728646b1e

See more details on using hashes here.

Supported by

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