Sandman-Lite

a lightweight script built with late night developers in mind

Crossplatform G.U.I. Version Can Be Found here

Sandman will remind you to take a rest and that you can always come back to the work tomorrow.

A sleep cycle is a 90-minute chunk of time where your body transitions through various phases of sleep — all the way down to deep REM sleep — then back again. Some health experts believe that these 90-minute sleep cycles are the key to restful sleep. They recommend trying to sleep exactly 7.5 hours — or even 9 hours, if you have the time.

Based on the time you need to wake up — and assuming it will take you 15 minutes to fall asleep — Sandman will notify you throughout the evening at specific times when you could go to sleep and maximize your number of full sleep cycles.

This script works well with https://justgetflux.com/

Inspired by http://sleepyti.me

In Action

Installing

1). Get The Source Code

cd ~
git clone https://github.com/alexanderepstein/Sandman-Lite
cd Sandman-Lite

2). Install sandman-lite

To install the latest stable release

git checkout v1.6.0
chmod a+x install.sh
./install.sh

To install the nightly builds

chmod a+x install.sh
./install.sh

Usage

First set a desired wake up time using sandman-lite -s xx:xx

To get the times of the set notifications sandman-lite -g

To test the rest notification behavior sandman-lite -t

To remove all pending notifications sandman-lite -r

To check for and download/install sandman-lite updates sandman-lite -u

To get help using sandman-lite sandman-lite -h

To get sandman-lite version sandman-lite -v

Removing

cd ~/Sandman-Lite
./uninstall.sh

( •_•)
( •_•)>⌐■-■
(⌐■_■)

Helping Out

Feel free to fork this repository add some code and submit a pull request

List of yet to be implemented features

• Add option to show parsed times in 24 or 12 hour formatting
• No uptime notification
• No error exiting in main script

Known Bugs

• Uninstaller script doesn't uninstall the dependencies if they weren't their before installation of sandman-lite

Donate

If this project helped you in any way and you feel like buying a broke college kid a cup of coffee

License

MIT License

Copyright (c) 2017 Alex Epstein

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.