Skip to content
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
117 lines (85 sloc) 2.34 KB

LightUpAlarm package

This is an Alarm Clock Python package.

This README file is still under development.

Running LightUpAlarm


Currently tested on Python 2.7 and 3.4.

Install version 0.5.4 of Dataset:

pip install -I dataset=0.5.4


git clone git://
cd dataset/
git checkout 9a91f3d1139a022b8c29f7c4215f6500b9e39b75
python install


The LightUpAlarm can run independently with its own command line interface:

python LightUpAlarm

Using LightUpAlarm

LightUpAlarm can be used through its Command Line Interface.

Using the UP and DOWN arrow keys will go through your command history.

If the optional module pyreadline is installed it will enable tab auto-completion.

CLI screenshot

The following commands are available:


Displays the active alarms currently running.


Add an alarm using the format (days follow the 3 letter format):

hh mm <enabled/disabled> <days to repeat>


add 9 00 enabled Mon Fri
add 10 30 disabled sat sun
add 7 10 enabled all
add 22 55 disabled


Displays all the alarms.

Use the keyword 'full' to display additional info.


Delete an alarm identified by its id, or all the alarms. E.g.:

delete 3
delete all


Edit an alarm using the following format:

edit <alarm ID> <attribute> <new value>


edit 3 hour 9
edit 4 minute 30
edit 7 enabled no
edit 1 repeat mon fri


Displays the next scheduled alarm to alert.


Displays the currently set offset alert time, (time before the alarm alert is triggered and used to launch any kind of process), or if accompanied by an integer it will change the offset alert time and display the new value. E.g.:

offsetalert 5
offsetalert -15


Displays the currently set snooze time, or if accompanied by an integer it will change the snooze time and display the new value. E.g.:

snooze 5


List all available commands, or display detailed help with:

help <cmd>


Exists the LightUp Alarm program.


This project is licensed under The MIT License (MIT), a copy of which can be found in the LICENSE file.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.