Headless renderer for Kivy framework
Project description
Kivy Headless Renderer
This project provides utilities to render Kivy applications headlessly. It can be used in test environments to run the app headlessly and use its tools for snapshot testing. It can also be used on a Raspberry Pi or similar devices to render the Kivy application on a custom display like an SPI display.
The renderer is optimized to not update the schedule a render when nothing has changed since the last rendered frame.
When ran on a desktop environment, the renderer will render the Kivy application in a normal window. This is to ease the process of development and debugging.
📦 Installation
pip install headless-kivy
To work on a non-RPi environment, run this:
# pip:
pip install headless-kivy[dev]
# poetry:
poetry --group dev headless-kivy
🛠 Usage
-
Call setup_headless() before inheriting the
HeadlessWidget
class for the root widget of your application, and provide the optional parameters as needed. For example (these are all default values, you only need to provide the ones you want to change):setup_headless( min_fps=1, max_fps=30, width=240, height=240, is_debug_mode=False, display_class=ST7789, double_buffering=True, automatic_fps=True, )
-
Inherit the
HeadlessWidget
class for the root widget of your Kivy application. For example:class FboFloatLayout(FloatLayout, HeadlessWidget): pass
-
Run the Kivy app as you normally would.
Checkout Ubo App to see a sample implementation.
⚙️ Parameters
These parameters can be set to control the behavior of headless kivy:
min_fps
Minimum frames per second for when the Kivy application is idle.
max_fps
Maximum frames per second for the Kivy application.
width
The width of the display in pixels.
height
The height of the display in pixels.
is_debug_mode
If set to True, the application will print debug information, including FPS.
double_buffering
Is set to True
, it will let Kivy generate the next frame while sending the last
frame to the display.
automatic_fps
If set to True
, it will monitor the hash of the screen data, if this hash changes,
it will increase the fps to the maximum and if the hash doesn't change for a while,
it will drop the fps to the minimum.
rotation
The rotation of the display. It will be multiplied by 90 degrees.
flip_horizontal
If set to True
, it will flip the display horizontally.
flip_vertical
If set to True
, it will flip the display vertically.
🤝 Contributing
You need to have Poetry installed on your machine.
After having poetry, to install the required dependencies, run the following command in the root directory of the project:
poetry install
⚠️ Important Note
This project has only been tested with the ST7789 SPI display module. Other display modules might not be compatible or may require changing the parameters or even modifications to the code.
🔒 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
Hashes for headless_kivy-0.9.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9248e442df5e4892af16cbca0aadfaecb3ee968117aae5ecb8ef4e35988e4c46 |
|
MD5 | dcf58ee2e27d8b65f486faf114341757 |
|
BLAKE2b-256 | 7e1116b2fb24257d96544d74f427a7c9397c710a302ede9e0b52f9228937f1a3 |