Skip to content

Commit

Permalink
testing making a change
Browse files Browse the repository at this point in the history
  • Loading branch information
ellengoddard committed Apr 16, 2024
1 parent a4bf55e commit 121823b
Show file tree
Hide file tree
Showing 8 changed files with 121 additions and 3,262 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,6 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/

# Unknown file
.DS_Store
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@ This should align with:
* Releases on [PyPI](https://pypi.org/project/kailo-beewell-dashboard/#history)
* Releases on [GitHub](https://github.com/kailo-beewell/kailo_beewell_dashboard_package/releases) (which are like a non-portable changelog only displayed to users within GitHub)

## 0.3.3

**Release date:** 16th April 2024

**Contributors:** Ellen Goddard

Test making a change to package

### Added
* Test sentence

## 0.3.2

**Release date:** 12th April 2024
Expand Down
8 changes: 6 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ authors:
email: [email protected]
affiliation: University of Exeter
orcid: 'https://orcid.org/0000-0002-6596-3479'
- given-names: Ellen
family-names: Goddard
email: [email protected]
affiliation: Dartington Service Design Lab
repository-code: >-
https://github.com/kailo-beewell/kailo_beewell_dashboard_package
repository-artifact: 'https://pypi.org/project/kailo-beewell-dashboard/'
Expand All @@ -25,5 +29,5 @@ keywords:
- '#BeeWell'
- Kailo
license: MIT
version: 0.3.2
date-released: '2024-04-12'
version: 0.3.3
date-released: '2024-04-16'
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `kailo-beewell-dashboard`: tools to support creation of #BeeWell survey dashboards for the Kailo project.

[![PyPI package](https://img.shields.io/badge/PyPI_package-0.3.2-2596be.svg)](https://pypi.org/project/kailo-beewell-dashboard/0.3.2/)
[![PyPI package](https://img.shields.io/badge/PyPI_package-0.3.3-2596be.svg)](https://pypi.org/project/kailo-beewell-dashboard/0.3.3/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![ORCID: Amy Heather](https://img.shields.io/badge/ORCID_Amy_Heather-0000--0002--6596--3479-brightgreen)](https://orcid.org/0000-0002-6596-3479)

Expand All @@ -23,14 +23,14 @@ This package contains functions that are used in the creation of the various #Be

If you use this package, please include the following citation

> Heather, Amy. (2024). kailo-beewell-dashboard: tools to support creation of #BeeWell survey dashboards for the Kailo project (0.3.2). https://pypi.org/project/kailo-beewell-dashboard/.
> Heather, Amy. and Goddard, Ellen. (2024). kailo-beewell-dashboard: tools to support creation of #BeeWell survey dashboards for the Kailo project (0.3.3). https://pypi.org/project/kailo-beewell-dashboard/.
```tex
@software{kailo-beewell-dashboard,
author = {Heather, Amy},
author = {Heather, Amy. and Goddard, Ellen.},
title = {kailo-beewell-dashboard},
date = {2024-04-12},
version = {0.3.2},
date = {2024-04-16},
version = {0.3.3},
publisher = {PyPI},
url = {https://pypi.org/project/kailo-beewell-dashboard/}
}
Expand Down
4 changes: 2 additions & 2 deletions kailo_beewell_dashboard/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
Tools to support creation of #BeeWell survey dashboards for Kailo.
'''

__version__ = '0.3.2'
__author__ = 'Amy Heather'
__version__ = '0.3.3'
__author__ = 'Amy Heather and Ellen Goddard'
179 changes: 90 additions & 89 deletions kailo_beewell_dashboard/about_page.py
Original file line number Diff line number Diff line change
@@ -1,156 +1,157 @@
'''
"""
Helper functions to produce the About page for each version of the dashboard
'''
"""

from kailo_beewell_dashboard.images import get_image_path
from kailo_beewell_dashboard.reuse_text import reuse_text
from kailo_beewell_dashboard.stylable_container import header_container
import streamlit as st


def symbol_content():
'''
"""
Descriptions content of symbol survey using combination of text and images
(hence provided as function, rather than using reuse_text like all the
other About page sections)
'''
st.markdown('''The survey contained ten questions which use the Widgit
symbol system. These were:''')
"""
st.markdown("""The survey contained ten questions which use the Widgit
symbol system. These were:""")
# Add the images (they are the same as those used for the survey, but
# cropped to height of 340 to remove the 'choose one' from each)
st.image(get_image_path('symbol_survey/family_crop.png'))
st.image(get_image_path('symbol_survey/home_crop.png'))
st.image(get_image_path('symbol_survey/friends_crop.png'))
st.image(get_image_path('symbol_survey/choice_crop.png'))
st.image(get_image_path('symbol_survey/things_crop.png'))
st.image(get_image_path('symbol_survey/health_crop.png'))
st.image(get_image_path('symbol_survey/future_crop.png'))
st.image(get_image_path('symbol_survey/school_crop.png'))
st.image(get_image_path('symbol_survey/free_time_crop.png'))
st.image(get_image_path('symbol_survey/life_crop.png'))
st.markdown('For each questions, pupils had three response options:')
st.image(get_image_path('symbol_survey/choose_one.png'))
st.image(get_image_path("symbol_survey/family_crop.png"))
st.image(get_image_path("symbol_survey/home_crop.png"))
st.image(get_image_path("symbol_survey/friends_crop.png"))
st.image(get_image_path("symbol_survey/choice_crop.png"))
st.image(get_image_path("symbol_survey/things_crop.png"))
st.image(get_image_path("symbol_survey/health_crop.png"))
st.image(get_image_path("symbol_survey/future_crop.png"))
st.image(get_image_path("symbol_survey/school_crop.png"))
st.image(get_image_path("symbol_survey/free_time_crop.png"))
st.image(get_image_path("symbol_survey/life_crop.png"))
st.markdown("For each questions, pupils had three response options:")
st.image(get_image_path("symbol_survey/choose_one.png"))
cols = st.columns(3)
with cols[0]:
st.image(get_image_path('symbol_survey/happy.png'))
st.image(get_image_path("symbol_survey/happy.png"))
with cols[1]:
st.image(get_image_path('symbol_survey/ok.png'))
st.image(get_image_path("symbol_survey/ok.png"))
with cols[2]:
st.image(get_image_path('symbol_survey/sad.png'))
st.image(get_image_path("symbol_survey/sad.png"))


def create_about_page(dashboard_type):
'''
"""
Creates the 'About' page on the streamlit dashboard
Parameters
----------
dashboard_type : string
Specifies whether this is for 'standard' or 'symbol' school
dashboard, or for the 'public' area-level dashboard
'''
"""
# Page title
st.title('About')
st.title("About")
st.markdown("Test Ellen")

# Introduction
st.markdown(reuse_text['about_intro'])
st.markdown(reuse_text["about_intro"])

# Expand toggle
expand = st.toggle('Toggle to expand all the boxes below', value=False)
expand = st.toggle("Toggle to expand all the boxes below", value=False)

# FAQs about Kailo
header_container('green_container', '🌿 Kailo', '#D9ECCA')
header_container("green_container", "🌿 Kailo", "#D9ECCA")

# Description of the Kailo project
with st.expander('What is Kailo?', expanded=expand):
st.markdown(reuse_text['kailo'])
st.image(get_image_path('kailo_systems_adapted.png'),
use_column_width=True)
with st.expander("What is Kailo?", expanded=expand):
st.markdown(reuse_text["kailo"])
st.image(get_image_path("kailo_systems_adapted.png"), use_column_width=True)

# FAQs about the #BeeWell survey
header_container('orange_container', '🐝 The #BeeWell survey', '#F7DCC8')
header_container("orange_container", "🐝 The #BeeWell survey", "#F7DCC8")

# Survey sample
with st.expander('Who took part in the #BeeWell survey in Devon?',
expanded=expand):
if dashboard_type == 'symbol':
st.markdown(reuse_text['sample_symbol'])
with st.expander("Who took part in the #BeeWell survey in Devon?", expanded=expand):
if dashboard_type == "symbol":
st.markdown(reuse_text["sample_symbol"])
else:
st.markdown(reuse_text['sample'])
st.image(get_image_path('northern_devon.png'), use_column_width=True)
st.markdown(reuse_text["sample"])
st.image(get_image_path("northern_devon.png"), use_column_width=True)

# Survey content, and design of the survey
if dashboard_type == 'public':
if dashboard_type == "public":
# Public dashboard - survey content
with st.expander('What topics did the standard survey cover?',
expanded=expand):
st.markdown(reuse_text['standard_content'])
with st.expander('What topics did the symbol survey cover?',
expanded=expand):
with st.expander("What topics did the standard survey cover?", expanded=expand):
st.markdown(reuse_text["standard_content"])
with st.expander("What topics did the symbol survey cover?", expanded=expand):
symbol_content()
# Public dashboard - survey design
with st.expander('How was the standard survey designed?',
expanded=expand):
st.markdown(reuse_text['standard_design'])
st.image(get_image_path('canva_people.png'), use_column_width=True)
with st.expander('How was the symbol survey designed?',
expanded=expand):
st.markdown(reuse_text['symbol_design'])
with st.expander("How was the standard survey designed?", expanded=expand):
st.markdown(reuse_text["standard_design"])
st.image(get_image_path("canva_people.png"), use_column_width=True)
with st.expander("How was the symbol survey designed?", expanded=expand):
st.markdown(reuse_text["symbol_design"])
else:
# School dashboards - survey content
with st.expander('What topics did the survey cover?', expanded=expand):
if dashboard_type == 'standard':
st.markdown(reuse_text['standard_content'])
elif dashboard_type == 'symbol':
with st.expander("What topics did the survey cover?", expanded=expand):
if dashboard_type == "standard":
st.markdown(reuse_text["standard_content"])
elif dashboard_type == "symbol":
symbol_content()
# School dashboards - survey design
with st.expander('How was the survey designed?', expanded=expand):
if dashboard_type == 'standard':
st.markdown(reuse_text['standard_design'])
elif dashboard_type == 'symbol':
st.markdown(reuse_text['symbol_design'])
st.image(get_image_path('canva_people.png'), use_column_width=True)
with st.expander("How was the survey designed?", expanded=expand):
if dashboard_type == "standard":
st.markdown(reuse_text["standard_design"])
elif dashboard_type == "symbol":
st.markdown(reuse_text["symbol_design"])
st.image(get_image_path("canva_people.png"), use_column_width=True)

# Other #BeeWell sites
with st.expander('Where else have these surveys been completed?',
expanded=expand):
st.markdown(reuse_text['other_beewell_sites'])
st.image(get_image_path('beewell_map.png'), use_column_width=True)
with st.expander("Where else have these surveys been completed?", expanded=expand):
st.markdown(reuse_text["other_beewell_sites"])
st.image(get_image_path("beewell_map.png"), use_column_width=True)

# FAQs about the dashboard
header_container('blue_container', '📊 Dashboard', '#D0C9FF')
header_container("blue_container", "📊 Dashboard", "#D0C9FF")

# Data used to create the dashboard
with st.expander('What data has been used in this dashboard?',
expanded=expand):
if dashboard_type == 'standard':
st.markdown(reuse_text['standard_data'])
elif dashboard_type == 'symbol':
st.markdown(reuse_text['symbol_data'])
elif dashboard_type == 'public':
st.markdown(reuse_text['public_data'])
with st.expander("What data has been used in this dashboard?", expanded=expand):
if dashboard_type == "standard":
st.markdown(reuse_text["standard_data"])
elif dashboard_type == "symbol":
st.markdown(reuse_text["symbol_data"])
elif dashboard_type == "public":
st.markdown(reuse_text["public_data"])

# How to use the results
with st.expander('How should we use these results?', expanded=expand):
st.markdown(reuse_text['how_to_use_results'])
st.image(get_image_path('thinking.png'), use_column_width=True)
with st.expander("How should we use these results?", expanded=expand):
st.markdown(reuse_text["how_to_use_results"])
st.image(get_image_path("thinking.png"), use_column_width=True)

# Accessing the dashboard on different devices
with st.expander('Can I access this dashboard on different devices?',
expanded=expand):
st.markdown(reuse_text['view_devices'])
st.image(get_image_path('devices.png'), use_column_width=True)
with st.expander(
"Can I access this dashboard on different devices?", expanded=expand
):
st.markdown(reuse_text["view_devices"])
st.image(get_image_path("devices.png"), use_column_width=True)

# Support with dashboards (for school dashboards only)
if dashboard_type != 'public':
with st.expander('''
if dashboard_type != "public":
with st.expander(
"""
Will there be support available for interpreting and actioning on the dashboard
results?''', expanded=expand):
st.markdown(reuse_text['dashboard_support'])
results?""",
expanded=expand,
):
st.markdown(reuse_text["dashboard_support"])

# FAQs about wellbeing
header_container('yellow_container', '😌 Wellbeing', '#FFF3B3')
header_container("yellow_container", "😌 Wellbeing", "#FFF3B3")

# What do we already know?
with st.expander('''
What do we already know about young people's wellbeing?''', expanded=expand):
st.markdown(reuse_text['wellbeing_context'], unsafe_allow_html=True)
with st.expander(
"""
What do we already know about young people's wellbeing?""",
expanded=expand,
):
st.markdown(reuse_text["wellbeing_context"], unsafe_allow_html=True)
Loading

0 comments on commit 121823b

Please sign in to comment.