# 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
  - Submodules
  - watchme.command.commit module
  - watchme.command.create module
  - watchme.command.utils module
  - Module contents
- watchme.config package
  - Module contents
- watchme.logger package
  - Submodules
  - watchme.logger.message module
  - watchme.logger.namer module
  - watchme.logger.progress module
    - clint.textui.progress
  - watchme.logger.spinner module
  - Module contents
- watchme.tasks package
  - Submodules
  - watchme.tasks.worker module
  - Module contents
- watchme.utils package
  - Submodules
  - watchme.utils.fileio module
  - watchme.utils.terminal module
  - Module contents
- watchme.watchers package
  - Subpackages
    - watchme.watchers.psutils package
      - Submodules
      - watchme.watchers.psutils.tasks module
      - Module contents
    - watchme.watchers.urls package
      - Submodules
      - watchme.watchers.urls.tasks module
      - Module contents
  - Submodules
  - watchme.watchers.data module
  - watchme.watchers.schedule module
  - watchme.watchers.settings module
  - Module contents

## 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)

  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)

  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))