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 Install dependencies

Use pipenv to install the requirements in a virtual environment

    pipenv install

OR

Manually install requirements using pip

    pip install <requirements from Pipfile>

1.3 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.4 Set up OpenWeatherMap API Key

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

1.5 Set up Microsoft App ID

Set up your app with Microsoft Graph. For the time being, I do not know if my app_id will work for all users, but feel free to test it by removing that setting in .secrets.toml. Otherwise, you will need to set up a free account and register the app yourself. Check out Microsoft's page for more help with this. You should get an app_id from this, which should also be added in .secrets.toml under the setting for app_id in the To_Do_Widget category.

    [To_Do_Widget]
        app_id = "<Your App Id Here>"

1.6 Set up Spotify API

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

1.7 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.

1.8 Run the app

If pipenv was used:

    pipenv run python main.py

OR

If not, just run:

    python main.py