https://github.com/luke7-404/take-a-break

This project is for window users to have a pomodoro-like notification system.
https://github.com/luke7-404/take-a-break

beginner beginner-code code-review configurable pomodoro-clock python

Last synced: 3 days ago
JSON representation

This project is for window users to have a pomodoro-like notification system.

• Host: GitHub
• URL: https://github.com/luke7-404/take-a-break
• Owner: luke7-404
• License: mit
• Created: 2024-04-10T00:12:36.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-04-11T02:20:13.000Z (10 months ago)
• Last Synced: 2024-04-11T05:37:29.073Z (10 months ago)
• Topics: beginner, beginner-code, code-review, configurable, pomodoro-clock, python
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Take A Break Python Script

This project is intended for window users to have a pomodoro-like notification system. The libaries used in ``app.py`` are ``plyer``, ``datetime``, and ``time``. 

## How to edit the script:

To change the interval time (the amount of working time) alter the ``INTERVAL_TIME`` variable (the units are in minutes).

To change the time between the time intervals alter the ``REST_TIME`` variables with the number of minutes between the intervals.

## Benchmarking ``app.py``:

There is a file in this repo, called ``benchmark.py`` that allows for the ``app.py`` script to be benchmarked. I encourage that before having the ``app.py`` script run on your machine, the script should be benchmarked!

## Build and use script (Windows instructions)

Once configuring ``app.py`` and benchmarking it, to make the script into a windows executable use ``pyinstaller``.



    
Install pyinstaller: 

        


            pip install pyinstaller

        

    

    
Create a .exe:

        


            pyinstaller --name "Take-A-Break" -- onefile --noconsole app.py

            

            


            This generates an executable file in the dist/ folder.

        

    



### How to make the script run on start up



    
Create a shortcut for the Take-A-Break.exe

    

    
Add shortcut to startup folder:

        


            
Run the command win + r



            
In the window type shell:startup



            
Add the Take-A-Break.exe shortcut to the folder that opened

        

    



###### 

This program uses the MIT License, please look at the license page for more information