Skip to content

Latest commit

 

History

History
88 lines (79 loc) · 3.05 KB

INSTALL.md

File metadata and controls

88 lines (79 loc) · 3.05 KB

Installation Instructions

Install TKinter GUI toolkit

Debian

$ sudo apt install python-tk

Arch

$ sudo pacman -S python-tk

Install Latest Release of TDPlanner

  • Open a terminal and install the application by cloning the repository into a specific directory
$ git clone https://github.com/BooleanCube/TDPlanner.git
  • Running python3 main.py gets the job done, but by making main.py executable with sudo chmod +x main.py, you can run the application with ./main.py without having to call python.
  • Creating a desktop profile is convenient but optional.

Compile your own executable file instead of installing from the latest stable releases.

  • Simply install pyinstaller by using pip install pyinstaller or python -m pip install pyinstaller
  • Compile the executable file by running one of 2 console commands that may work for you:
$ pyinstaller main.py --onefile
$ python -m PyInstaller main.py --onefile

Install Latest Stable Release of TDPlanner

  • Select the latest release from the releases page
  • Download the .zip file.
  • Extract the folder and cd into the folder to see its contents.
  • Make the tdplanner file executable using
$ chmod +x tdplanner
  • Run the tdplanner file to open/start the application using:
$ ./tdplanner

Install matplotlib and PyQt5 (only in some cases)

If the few steps above didn't work for you, the issue probably lies with the matplotlib package not being installed.
Based on how pip is setup on your computer run one of the two commands to install matplotlib and retry running tdplanner

$ pip install matplotlib
$ pip install pyqt5

or

$ python3 -m pip install matplotlib
$ python3 -m pip install pyqt5

Creating a desktop profile for the application (optional for application integration)

Debian

  • Create a TDPlanner.desktop in the Desktop/ folder and put this configuration code within the file:
[Desktop Entry]
Name=TDPlanner
Version=v1.0.1
Icon=tdplanner
X-Icon-Path=/path/to/icon/file/
Exec=./path/to/py/file/main.py
Terminal=false
Comment=To Do List Planner Application for Productivity
Type=Application
  • In the terminal set the permissions of the desktop file to be executable by typing this: sudo chmod u+x path/to/py/file/main.py
  • Right click on the new empty document and in the Permissions tab, set the execute to allow executing file as program

Arch

  • Make sure the script is executable by running: sudo chmod +x path/to/py/file/main.py
  • Create a symlink to the script in /usr/bin/ and make it executable by running the chmod command again.
  • Create a TDPlanner.desktop in the /home/.local/share/applications/ folder and put this configuration code within the file:
[Desktop Entry]
Name=TDPlanner
Version=v1.0.1
Icon=tdplanner
X-Icon-Path=/path/to/icon/file/
Exec=./path/to/py/file/main.py
Terminal=false
Comment=To Do List Planner Application for Productivity
Type=Application