Getting Started

For now, there is no installer or prepackaged installation for this project. This will be coming in the future. For now, follow the installation instructions below.

1. Installation

1.1 Clone the repo

   git clone https://github.com/Bennett-Wendorf/Kivy-Raspi-Desktop-App.git

1.2 Change directory into the new repo

   cd Kivy-Raspi-Desktop-App

1.3 Install dependencies

If this option is used, it is recommended to also install pyenv to manage python versions that may be different from the one installed by your package manager. Please refer to the Pyenv Github Page for instructions installing.

Use pipenv to install the requirements in a virtual environment

    pipenv install

OR

Manually install requirements using pip

    pip install <requirements from Pipfile>

1.4 Create .secrets.toml

Make a copy of the TEMPLATE.secrets.toml file and rename the copy to .secrets.toml. This is where you will add settings that shouldn't be pushed to a repository, such as API keys.

1.5 Set up OpenWeatherMap API Key

See the Set up OpenWeatherMap API page for instructions on this.

1.6 Set up Microsoft App ID

Most likely, you will not need to do anything here. My app id is included in the MSALHelper.py file, and should work for most Microsoft accounts. However, if you seem to be getting errors with Microsoft authentication, you can follow the steps here.

1.7 Set up Spotify API

See the Set up Spotify API page for instructions on this.

1.8 Modify Settings

Modify any other settings you would like in the settings.toml file. What is listed in that file already is also the default if that particular setting is not specified, with the exception of the lists_to_use setting, which defaults to an empty list.

2 Check other requirements

2.1 Ensure a web browser is installed for authentication

A web browser must be installed for proper authentication to both Microsoft To Do and Spotify. Make sure that one is installed before trying to run the application. If you're looking for something basic and very lightweight, I highly recommend Midori.

2.2 Ensure the clock is set properly

An incorrect time will cause issues with authenticating to Microsoft. By default on RaspiOS, the clock is set up with network time synchronization, so you should be OK there. On other distributions, refer to their documentation for this. Also check out this great article on setting system time in Linux.

3 Run the app

If pipenv was used:

    pipenv run python main.py

OR

If not, just run:

    python main.py