-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
The executable can be obtained from the releases page under Assets for a given release, or in the repository under the distrib
directory. Go ahead and download the zip(if applicable) and extract it.
git clone https://github.com/Bennett-Wendorf/Deskity.git
cd Deskity
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.
One some debian-based distributions, a few other dependencies are needed through the package manager. Run the following command to install them:
sudo apt install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev libportmidi-dev libswscale-dev libavformat-dev libavcodec-dev zlib1g-dev libgl1-mesa-dev libjpeg-dev python-dev python3-dev
Use pipenv to install the requirements in a virtual environment
pipenv install
OR
Manually install requirements using pip
pip install <requirements from Pipfile>
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.
See the Set up OpenWeatherMap API page for instructions on this.
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.
See the Set up Spotify API page for instructions on this.
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.
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.
In addition, make sure you have a web browser set as default. Check out this page if you are having trouble with that.
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.
Choose one of the options below depending on installation method:
- Navigate to the directory where the zip was extracted
-
cd
into theDeskity-<architecture>-dir-<version>
directory (replace architecture with the version of the build you want, and version with the version you downloaded.) - Run the executable like
./Deskity <options>
If pipenv was used:
pipenv run python main.py
OR
If not, just run:
python main.py