Dependencies

The only dependency for watchme is to have git and crontab on your system. Git is used for version control of the pages you are watching, and crontab is used for scheduling your watches. If you want to install a custom watcher type, see installing extras below.

Install

WatchMe can be installed natively (python 3 recommended) with pip:

pip install watchme

or you can clone and install from source:

$ git clone https://www.github.com/vsoch/watchme
$ cd watchme
$ python setup.py install

When you have installed WatchMe, there will be an executable “watchme” placed in your bin folder:

which watchme
/home/vanessa/anaconda3/bin/watchme

and you should be able to run the executable and see the usage:

$ watchme

[WatchMe]  Command Line Tool v0.0.1
usage: watchme [-h] [--debug] [--version] [--quiet] {init,create} ...

WatchMe Command Line Tool

optional arguments:
  -h, --help     show this help message and exit
  --debug        use verbose logging to debug.
  --version      show version and exit.
  --quiet        suppress additional output.

actions:
  actions for HelpMe Command Line Tool

  {init,create}  watchme actions
    init         initialize watchme
    create       create a new watcher

If you have any questions or issues, please open an issue.

Installing Extras

If you want to install all of watchme’s exporters and watchers:

$ pip install watchme[all]

To install all watchers only:

$ pip install watchme[watchers]

or a specific watcher task group:

$ pip install watchme[watcher-urls-dynamic]
$ pip install watchme[watcher-psutils]

To see all of the choices, see here in the setup file.