kailo_beewell_dashboard.static_report

Function to generate a non-interactive PDF version of the dashboard as a temporary file that can then be downloaded from the dashboard

Module Contents

Functions

logo_html()	Generates HTML string to create logo as displayed on cover page of reports.
illustration_html()	Generates DIV element containing illustration as displayed on cover page of
structure_report(pdf_title, content)	Inserts the provided HTML into the structure of the report - PDF title,
create_static_report(chosen_school, chosen_group, ...)	Generate a static PDF report for the chosen school and group, with all
create_static_symbol_report(chosen_school, df_prop, ...)	Generate a static symbol survey PDF report for the chosen school and group,

kailo_beewell_dashboard.static_report.logo_html()

Generates HTML string to create logo as displayed on cover page of reports.

Returns

img_tagstring

HTML to generate the logo

kailo_beewell_dashboard.static_report.illustration_html()

Generates DIV element containing illustration as displayed on cover page of reports.

Returns

illustrationstring

HTML to generate div containing the illustration

kailo_beewell_dashboard.static_report.structure_report(pdf_title, content)

Inserts the provided HTML into the structure of the report - PDF title, importing and reading the CSS style, and inserting the content of report

Parameters

pdf_titlestring

Title for the pdf file

contentstring

HTML content of the report

Returns

html_contentstring

HTML to produce the styled report

kailo_beewell_dashboard.static_report.create_static_report(chosen_school, chosen_group, df_scores, df_prop, counts, dem_prop, pdf_title)

Generate a static PDF report for the chosen school and group, with all the key information and figures from the dashboard

Parameters

chosen_schoolstring

Name of the chosen school

chosen_groupstring

Name of the chosen group to view results by - options are ‘For all pupils’, ‘By year group’, ‘By gender’, ‘By FSM’ or ‘By SEN’

df_scoresdataframe

Dataframe with aggregate scores and RAG for each topic

df_propdataframe

Dataframe with proportion of each response to each survey question

countsdataframe

Dataframe with the counts of pupils at each school

dem_propdataframe

Dataframe with proportion of each reponse to the demographic questions

pdf_titlestring

Title for the PDF file

kailo_beewell_dashboard.static_report.create_static_symbol_report(chosen_school, df_prop, counts, dem_prop, pdf_title)

Generate a static symbol survey PDF report for the chosen school and group, with all the key information and figures from the dashboard

Parameters

chosen_schoolstring

Name of the chosen school

df_propdataframe

Dataframe with proportion of each response to each survey question

countsdataframe

Dataframe with the counts of pupils at each school

dem_propdataframe

Dataframe with proportion of each reponse to the demographic questions

pdf_titlestring

Title for the PDF file