Welcome to the UI’s documentation!

Note

This project is under active development.

Clock UI

pre-commit.ci status Tests Code style: black Documentation Status


Documentation


Usage

Installation

Note

Please wait for full release (i.e. v1) before using it.

To use the ui, first install it using pip:

git clone git@github.com:Town-Clock/RPi_Clock_UI.git
cd RPi_Clock_UI
pip install .

API

Submodules

clock_ui.main module

Main module for Clock UI Package.

Author: Zack Hankin

Started: 27/02/2023

clock_ui.main.main() int[source]

Main function for Package

Returns:

Exitcode for program.

Return type:

Int

Module contents

Clock UI

Indices and tables