# watchme.watchers.results package

## Submodules

## watchme.watchers.results.tasks 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/.

`watchme.watchers.results.tasks.``from_env_task`(**kwargs)

  Get some set of variables from the environment. We look for those defined in kwargs, but also any in the environment that start with the prefix WATCHMENEV_. They are saved to files that are equivalently named, and the idea is that we can track a changing (single) result, meaning that the timestamp is meaningful, or we can track values for many different results, so the timestamps just serve to record when each was recorded.

  Parameters

    * (any number of parameters from the task configuration that will) – be looked for in the environment.

## 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/.

class `watchme.watchers.results.``Task`(name, params=None, **kwargs)

  Bases: `watchme.tasks.TaskBase`

  a results task aims to use WatchMe as a database, meaning the functions are optimized to collect and record results.

  `export_func`()

    this function should return the correct task (from the tasks.py in the same folder) based on some logic of the params that are given by the user (self.params). If there is only one kind of function for the task, it’s fairly easy to import and return it here. This function should take no arguments, but instead use the self.params already provided in the client.

  `required_params` = []