Command line

class psynet.command_line.ListOfStrings

Bases: ParamType

convert(value, param, ctx)

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call fail() with a descriptive message.

Parameters:

• value – The value to convert.

• param – The parameter that is using this type to convert its value. May be None.

• ctx – The current context that arrived at this value. May be None.

name: str = 'list_of_strings'

the descriptive name of this type

psynet.command_line.export_(ctx, exp_variables, app=None, local=False, path=None, assets='experiment', anonymize='both', n_parallel=None, no_source=False, docker_ssh=False, server=None, dns_host=None, username=None, password=None)

Export data from an experiment.

The data is exported in three distinct formats into the ‘data/data-<app>’ directory of an experiment which has following structure:

data/
└── data-<app>/
    ├── csv/
    ├── db-snapshot/
    └── json/

csv:

Contains the experiment data in CSV format.

db-snapshot:

Contains the zip file generated by the default Dallinger export command.

json:

Contains the experiment data in JSON format.

psynet.command_line.export_launch_data(deployment_id, **kwargs)

Retrieves dashboard credentials from the current config and saves them to disk.

psynet.command_line.log(msg, chevrons=True, verbose=True, **kw)

Log a message to stdout.

psynet.command_line.update_scripts_()

To be run in an experiment directory; updates a collection of template scripts and help files to their latest PsyNet versions.

psynet.command_line.user_confirms(question, default=False)

Like click.confirm but safe for using within our wrapped Docker commands.