jump_starter.questionnaire

Attributes

`VIEWS_PACKAGE_PATH`
`OUTPUT_BOX_TEMPLATE_FILE`
`OUTPUT_BOX_STYLE_FILE`
`QUESTION_BOX_STYLE_FILE`
`QUESTION_BOX_LAYOUT`
`OUTPUT_BOX_LAYOUT`

Classes

QuestionnaireWidget

A widget to run an interactive questionnaire in a Jupyter notebook.

Module Contents

VIEWS_PACKAGE_PATH = 'jump_starter.views'[source]

OUTPUT_BOX_TEMPLATE_FILE = 'output_box.html.jinja'[source]

OUTPUT_BOX_STYLE_FILE = 'output_box.css'[source]

QUESTION_BOX_STYLE_FILE = 'question_box.css'[source]

QUESTION_BOX_LAYOUT[source]

OUTPUT_BOX_LAYOUT[source]

class QuestionnaireWidget(questionnaire: jump_starter.models.Questionnaire, save_directory: str | None = None, initial_answers: jump_starter.models.QuestionAnswers | None = None)[source]

A widget to run an interactive questionnaire in a Jupyter notebook.

questions[source]

initial_template[source]

initial_commentary[source]

feedback_url[source]

save_directory = None[source]

_load_resources()[source]

_init_state()[source]

_init_ui()[source]

_start_with_answers(question_answers: jump_starter.models.QuestionAnswers)[source]

_add_questions_to_stack(questions: list[jump_starter.models.Question | jump_starter.models.Switch])[source]

_get_next_question() → jump_starter.models.Question | None[source]

_render_next_question()[source]

_render_question_box()[source]

_generate_previous_questions()[source]

_handle_answer(answer_index: int, render: bool = True)[source]

_update_template(templates: list[jump_starter.models.Template])[source]

_render_output_box()[source]

_get_question_answers(up_to_index=None) → jump_starter.models.QuestionAnswers[source]

Get a QuestionAnswers model containing all answers, optionally up to the specified index.

Parameters:: up_to_index (int, optional) – The index up to which to include answers. If None, includes all answers. Defaults to None.
Returns:: The collected question answers.
Return type:: QuestionAnswers

_save_answers(_)[source]: Save all user answers to a YAML file.

show()[source]: Display the widget in a Jupyter notebook.