Blind User Interface examples

BUI provides simple examples you can run to test the application and see how the code works. If you have cloned the repository, you will find these examples in the example directory. You will also find them online (see below).

Installation

These examples are standalone examples, meaning you just need to install BUI and enable the feature to run these examples. To do so, run pip:

pip install bui[demo]

Specifying [demo] will install additional packages that may be required by one example. Preferably, run this command in a virtual environment. Then, head over to an example.

Run an example

Assuming you are interested in the download example, and you would like to test it: nothing easier!

Open the download.py file. If you have cloned the repository, you will find it in the example directory (see it on Github. Otherwise, open the example page for the download app. Above is a quick explanation of the example, read it or skip it. Below you will see the source code. Just above the source code are two links to open the example as a raw file or in Github. Select either, save the file on your computer and run it with Python:

python download.py

And you should see the example appear.

List of examples

Example	Description
basic.py	Show a simple BUI window.
download.py	Show a window with a download queue.