https://github.com/yaroslaff/lightsleep

sleep() you can interrupt with redis or websocket event
https://github.com/yaroslaff/lightsleep

cron cronjob instant interrupt interruption redis safe sleep websocket

Last synced: about 1 month ago
JSON representation

sleep() you can interrupt with redis or websocket event

• Host: GitHub
• URL: https://github.com/yaroslaff/lightsleep
• Owner: yaroslaff
• License: mit
• Created: 2022-02-03T20:38:00.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-18T16:54:18.000Z (over 2 years ago)
• Last Synced: 2024-10-14T13:36:30.941Z (2 months ago)
• Topics: cron, cronjob, instant, interrupt, interruption, redis, safe, sleep, websocket
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lightsleep

Lightsleep is sleep() you can interrupt with redis or websocket event or touch/write file.

This is nice feature if you want to do some actions periodically AND immediately on some event.

# Install

Install from pypi:

~~~

pip3 install lightsleep

~~~

... or install from git:

~~~

pip3 install git+https://github.com/yaroslaff/lightsleep

~~~

## lsleep 

`lsleep.py` is very short simple CLI utility (better then `/usr/bin/sleep`) which is also demo how to use `lightsleep` python module.

Almost useless example where lsleep is identical to `/usr/bin/sleep` (sleep 60 seconds):

~~~

lsleep.py 60

~~~

Even this example has some benefits - if your program will run external program lsleep.py instead of `sleep()`, you can always send kill to lsleep (e.g. with `killall lsleep.py`) and this is much more reliable then interrupting `sleep()` inside program. But thats same as `/usr/bin/sleep`. 

If `-t`/`--title` set, lsleep.py will use setproctitle. So, you may call `lsleep.py 600 -t mysleep` and then `killall mysleep` to stop only this lsleep process. 

`lsleep.py -h` will list all available hooks and their default options

### Interrupt sleep with touch or any write

~~~

lsleep.py 300 --hook mtime path=/tmp/x

~~~

You can interrupt sleep with `touch /tmp/x` or `echo anything > /tmp/x`.

### interrupt sleep with redis PUBLISH command

`lsleep.py 60 --hook redis` (defaults: local redis server, channel `sleep`)

Interrupt this sleep from redis-cli:

~~~

127.0.0.1:6379> PUBLISH sleep anything

(integer) 1

~~~

To override defaults parameters: 

~~~

lsleep.py 60 --hook redis url=redis://localhost:6379/0 msg=stop ch=sleep

~~~

(seting `msg` to any value will requre to PUBLISH exact this value. If `msg` is not set, any message will interrupt sleep)

### Interrupt sleep with websocket 

~~~

lsleep.py 300 --hook ws url=http://localhost:8899/ room=myapps::u1 secret=myapps-pass

~~~

You may use [ws-emit](https://github.com/yaroslaff/ws-emit) websocket application as server.

optional `secret` if room requires secret to join (when room name containts '::'). This should match ws-emit secret in redis, set with `SET ws-emit::secret::myapps myapps-pass`

If `event` and `data` specified, sleep will be interrupted only if websocket event name and data matches it.

## Using sleep in your package

See lsleep.py code, it's very small. Example:

~~~python

from lightsleep import Sleep

s = Sleep(hook=['redis','msg=stop', 'ch=sleep'])

s.sleep(60)

~~~

`sleep()` returns message which interrupted sleep (if hook supports this). For example, if redis hook used and sleep was interrupted with `PUBLISH sleep zzz`, `sleep()` will return `zzz`.