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.

Installation

1. Clone the repo

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

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>

3. 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.
4. Get a free API Key for weather data at openweathermap.org/api.
   • Add this key in .secrets.toml under the setting for api_key in the Weather_Widget category.

     [Weather_Widget]
       api_key = "<Your Key Here>"

   • You can also try to use my API key by removing this setting from the file, but that may lead to throttling issues over time with OpenWeatherMap's free API. It is preferable to get your own key.
5. Set up your app with Microsoft Graph. For the timebeing, 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>"

6. 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.
7. Run the app
   • If pipenv was used:

     pipenv run python main.py

   OR
   • If not, just run:

     python main.py