SchedyDB

class schedy.SchedyDB(config_path=None, config_override=None)

SchedyDB is the central component of Schedy. It represents your connection the the Schedy service.

Parameters:

• config_path (str or file-object) – Path to the client configuration file. This file contains your credentials (email, API token). By default, ~/.schedy/client.json is used. See Installation and setup for instructions about how to use this file.
• config_override (dict) – Content of the configuration. You can use this to if you do not want to use a configuration file.

add_experiment(exp)

Adds an experiment to the Schedy service. Use this function to create new experiments.

Parameters:exp (schedy.Experiment) – The experiment to add.

Example

>>> db = schedy.SchedyDB()
>>> exp = schedy.ManualSearch('TestExperiment')
>>> db.add_experiment(exp)

get_experiment(name)

Retrieves an experiment from the Schedy service by name.

Parameters:name (str) – Name of the experiment. Returns:An experiment of the appropriate type. Return type:schedy.Experiment

Example

>>> db = schedy.SchedyDB()
>>> exp = db.get_experiment('TestExperiment')
>>> print(type(exp))
<class 'schedy.experiments.ManualSearch'>

get_experiments()

Retrieves all the experiments from the Schedy service.

Returns:Iterator over all the experiments. Return type:iterator of schedy.Experiment