pywatcher 0.4.0

monitor file and reload process. like gulp watch.

Copyright (c) 2018 denzow

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.

Description: pywatcher
===================

monitor file and reload process. like gulp watch

install
-----------

```sh
$ pip install pywatcher
```

usage
-----------

```sh
usage: pywatcher [-h] -t TARGET_DIR_PATH -c TARGET_COMMAND_STR
[-s RELOAD_THRESHOLD_SECONDS] [--disable-capture-stdout]
[-p [TARGET_PATTERN [TARGET_PATTERN ...]]]
[--signal {TERM,KILL}]

-----------------------------------------------------------------------
PyWatcher:

monitor file and reload process. like gulp watch

e.g:

pywatcher -t . -c 'ping localhost'
-> if some file on current dir changed, restart process 'ping localhost'.

-----------------------------------------------------------------------

optional arguments:
-h, --help show this help message and exit
-t TARGET_DIR_PATH, --target-dir TARGET_DIR_PATH
target directory for watching.
-c TARGET_COMMAND_STR, --command TARGET_COMMAND_STR
target command. this command execute and restart when file changed.
-s RELOAD_THRESHOLD_SECONDS, --reload-interval-seconds RELOAD_THRESHOLD_SECONDS
reload threshold seconds.
--disable-capture-stdout
is_disable_capture_stdout
-p [TARGET_PATTERN [TARGET_PATTERN ...]], --pattern [TARGET_PATTERN [TARGET_PATTERN ...]]
target pattern for monitoring. default, all file match.
--signal {TERM,KILL} reload_signal
```

if you quit PyWatcher, then `ctrl + c`.

examples
-------------

#### standard

```sh
(pywatcher) denzownoMacBook-Pro:pywatcher denzow$ pywatcher -t. -c 'ping localhost'
2018-03-11 23:35:37,114 - INFO - [start process]: ping localhost
2018-03-11 23:35:37,124 - DEBUG - [subprocess_output]: PING localhost (127.0.0.1): 56 data bytes
2018-03-11 23:35:37,124 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=0 ttl=64 time=0.043 ms
2018-03-11 23:35:38,129 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=1 ttl=64 time=0.132 ms
2018-03-11 23:35:39,133 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=2 ttl=64 time=0.161 ms
2018-03-11 23:35:40,138 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=3 ttl=64 time=0.152 ms
2018-03-11 23:35:41,142 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=4 ttl=64 time=0.062 ms
2018-03-11 23:35:42,147 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=5 ttl=64 time=0.095 ms
2018-03-11 23:35:43,141 - INFO - [reload process]: ping localhost <-- file changed. so reload
2018-03-11 23:35:43,141 - DEBUG - [subprocess_output]: b''
2018-03-11 23:35:43,141 - INFO - [start process]: ping localhost
2018-03-11 23:35:43,149 - DEBUG - [subprocess_output]: PING localhost (127.0.0.1): 56 data bytes
2018-03-11 23:35:43,149 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=0 ttl=64 time=0.044 ms
2018-03-11 23:35:44,152 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=1 ttl=64 time=0.063 ms
2018-03-11 23:35:45,152 - DEBUG - [subprocess_output]: 64 bytes from 127.0.0.1: icmp_seq=2 ttl=64 time=0.048 ms
```

#### more silently

no output subprocess.

```sh
(pywatcher) denzownoMacBook-Pro:pywatcher denzow$ pywatcher -t. -c 'ping localhost' --disable-capture-stdout
2018-03-11 23:36:12,559 - INFO - [start process]: ping localhost
2018-03-11 23:36:19,136 - INFO - [reload process]: ping localhost <-- file changed. so reload
2018-03-11 23:36:19,136 - INFO - [start process]: ping localhost
:
```

#### specified pattern

reload only '*.py' file modified.

```sh
(pywatcher) denzownoMacBook-Pro:pywatcher denzow$ pywatcher -t ./ -c 'ping localhost' -p '*.py'

```


#### send signal change

pywatcher send **SIGTERM** to process when reload. if you set `--signal KILL` option, send **SIGKILL**.

```sh
(pywatcher) denzownoMacBook-Pro:pywatcher denzow$ python pywatcher/command.py -t . -c 'echo reload' -s 1 --signal KILL
2018-05-03 11:57:37,940 - INFO - [start process]: echo reload
2018-05-03 11:57:37,945 - INFO - [start process]: PID is 4885
2018-05-03 11:57:37,952 - DEBUG - [subprocess_output]: reload
2018-05-03 11:57:46,657 - INFO - [reload process]: echo reload
2018-05-03 11:57:46,657 - DEBUG - KILL signal send to process
2018-05-03 11:57:46,657 - INFO - [start process]: echo reload
2018-05-03 11:57:46,660 - INFO - [start process]: PID is 4887
2018-05-03 11:57:46,662 - DEBUG - [subprocess_output]: reload
```
Platform: UNKNOWN