models.project

Overview

Enumerates Bpod project supported operations.

Implementation

class pybpodgui_api.models.project.Project[source]
create_board()

Add an board to the project, and return it.

Return type:Board
create_experiment()

Add an experiment to the project, and return it.

Return type:Experiment
create_subject()

Add an subject to the project, and return it.

Return type:Subject
create_task()

Add an task to the project, and return it.

Return type:Task
create_user()

Add a user bject to the project, and return it.

Return type:User
find_board(name)

Find a board by the name

Variables:name (str) – Name of the board to find.
Return type:Board
find_session(uuid4)
find_setup_by_id(uuid4)

Find a setup by the id

Variables:uuid4 (str) – UUID4 of the setup to find.
Return type:Setup
find_subject(name)

Find a subject by the name

Variables:name (str) – Name of the subject to find.
Return type:Subject
find_subject_by_id(uuid4)

Find a subject by the name

Variables:name (str) – Name of the subject to find.
Return type:Subject
find_task(name)

Find a task by the name

Variables:name (str) – Name of the task to find.
Return type:Task
find_user(username)
import_task(filepath, importdir=False)
is_saved()

Verifies if project has changes by doing a recursive checksum on all entities

Return type:bool
load(project_path)

Load project from a folder.

Variables:project_path (str) – Full path of the project to load.
remove_non_existing_repositories(path, names)
save(project_path)

Save project data on file :param str project_path: path to project :return: project data saved on settings file

boards

Get the list of boards in the project

Return type:list(Board)
experiments

Get the list of experiments in the project

Return type:list(Experiment)
name

Get and set the project name

Return type:str
path

Get and set the project path

Return type:str
subjects

Get the list of subjects in the project

Return type:list(Subject)
tasks

Get the list of tasks in the project

Return type:list(Task)
users

Get the list of users in the project

Return type:list(User)