watchme package¶
Subpackages¶
- watchme.client package
- Submodules
- watchme.client.activate module
- watchme.client.add module
- watchme.client.create module
- watchme.client.deactivate module
- watchme.client.edit module
- watchme.client.export module
- watchme.client.get module
- watchme.client.init module
- watchme.client.inspect module
- watchme.client.ls module
- watchme.client.protect module
- watchme.client.remove module
- watchme.client.run module
- watchme.client.schedule module
- Module contents
- watchme.command package
- watchme.config package
- watchme.logger package
- watchme.tasks package
- watchme.utils package
- watchme.watchers package
Submodules¶
watchme.defaults module¶
Copyright (C) 2019 Vanessa Sochat.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
The watcher is actually a connection to crontab. This is what helps to schedule the watched to check for changes at some frequency, and update the files.
-
watchme.defaults.getenv(variable_key, default=None, required=False, silent=True)[source]¶ attempt to get an environment variable. If the variable is not found, None is returned.
- Parameters
variable_key (the variable name)
required (exit with error if not found)
silent (Do not print debugging information for variable)
watchme.version module¶
Module contents¶
Copyright (C) 2019 Vanessa Sochat.
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
-
watchme.get_watcher(name='watcher', base=None, create=False, quiet=True, **kwargs)[source]¶ get the correct watcher depending on the environment variable WATCHME_WATCHER or default to “watcher”
- Parameters
name (the name of the watcher, will be made all lowercase)
base (the watcher base, if not defined, will use WATCHER_BASE_DIR envar)
create (if the watcher folder doesn’t exist, create it (default False)) – for all interactions with a watcher other than create, we should exit if the watcher the user wants doesn’t exist.
quiet (if True, suppress most output about the client (e.g. speak))