Improved markdown generation, updated besser example

besser_example.json

@@ -1 +1 @@
-{"master_title": "Besser", "master_desc": "The BESSER low-code platform is built on top of B-UML our  Python-based personal interpretation of a 'Universal Modeling Language' (yes, heavily inspired and a simplified version of the better known UML,  the Unified Modeling Language) ", "socialContext_description": "Besser is inteded to be used by a broad community of app developers without the need of having coding skills.", "socialContext_targetCommunity_name": "Teacher and student of computer science", "socialContext_targetCommunity_description": "Teacher and student of computer science", "socialContext_targetCommunity_age": [17, 120], "socialContext_targetCommunity_location": "University and education places", "socialContext_targetCommunity_workplace": "Hybrid", "socialContext_targetCommunity_ethnicities": "French, German, Arab", "socialContext_targetCommunity_genders": "", "socialContext_targetCommunity_disabilities": "", "socialContext_targetCommunity_religious": "", "socialContext_adaptation_name": "Computer Science Teachers", "socialContext_adaptation_description": "The software have been adapted for its specific use in educational environments", "participants_0_name": "Development Team", "participants_0_description": "The team in charge of developing the software", "participants_0_size": 15, "participants_0_age": [25, 36], "participants_0_location": "Luxembourg Institute of Technoogy", "participants_0_workplace": "Presential", "participants_0_ethnicities": "Colombian,Brasilian, Argentinian, French ,Spanish, Pakistani, Serbian, Iranian, Morroco, Italian", "participants_0_genders": "80% male, 20% famela", "participants_0_disabilities": "Non", "participants_0_religious": "Christianism, Islam", "governance_projectType": ["public funded"], "governance_govProcesses_0": "Besser is funded by the Luxembourg\u2019s National Research Fund (FNR) is the country\u2019s main agency for funding research across all scientific fields.", "governance_govProcesses_1": "The project is led by the recipient of the funds, its principal investigator.", "governance_bodies_0_name": "Luxembourg\u2019s National Research Fund (FNR)", "governance_bodies_0_description": "Luxembourg\u2019s National Research Fund (FNR) is the country\u2019s main agency for funding research across all scientific fields.", "governance_bodies_0_participant_name": "", "governance_bodies_0_participant_location": "", "governance_bodies_0_participant_workdplace": "Presential", "governance_bodies_0_participant_ethincity": "", "governance_bodies_0_participant_gender": "", "governance_bodies_0_participant_disabilities": "", "governance_bodies_0_participant_sexualOrientation": "", "governance_bodies_0_participant_religion": "", "governance_bodies_0_organization_name": "Luxembourg\u2019s National Research Fund (FNR)", "governance_bodies_0_organization_age": [10, 20], "governance_bodies_0_organization_location": "Luxembourg", "governance_bodies_0_organization_workplace": "Presential", "governance_bodies_0_organization_ethnicities": "", "governance_bodies_0_organization_genders": "", "governance_bodies_0_organization_disabilities": "", "governance_bodies_0_organization_religious": "", "governance_bodies_0_type": ["funders"], "governance_bodies_1_name": "Principal Investigator", "governance_bodies_1_description": "The PI who lead the project ", "governance_bodies_1_participant_name": "Jordi Cabot", "governance_bodies_1_participant_location": "Luxembourg Institute of Science and Technology", "governance_bodies_1_participant_workdplace": "Presential", "governance_bodies_1_participant_ethincity": "White", "governance_bodies_1_participant_gender": "Male", "governance_bodies_1_participant_disabilities": "None", "governance_bodies_1_participant_sexualOrientation": "Non-disclosed", "governance_bodies_1_participant_religion": "Non-disclosed", "governance_bodies_1_organization_name": "", "governance_bodies_1_organization_age": [10, 20], "governance_bodies_1_organization_location": "", "governance_bodies_1_organization_workplace": "Presential", "governance_bodies_1_organization_ethnicities": "", "governance_bodies_1_organization_genders": "", "governance_bodies_1_organization_disabilities": "", "governance_bodies_1_organization_religious": "", "governance_bodies_1_type": ["directors"], "governance_bodies_1_participant_countries": [], "governance_bodies_1_participant_edlevel": [], "governance_bodies_1_participant_sociostati": [], "governance_bodies_1_participant_skills": ["expert"], "governance_bodies_1_participant_languages": [], "socialContext_countries": ["Luxembourg", "France", "Germany", "Spain"], "socialContext_targetCommunity_countries": ["Luxembourg", "France"], "socialContext_targetCommunity_skills": ["beginner", "competent"], "participants_0_type": ["Development Team"], "participants_0_countries": ["Colombia", "Brazil", "Argentina", "France", "Spain", "Pakistan", "Serbia", "Iran,IslamicRepublicof"], "participants_0_edlevel": ["masterEquivalent", "doctorateEquivalent"], "participants_0_skills": ["proficient", "expert"], "participants_1_name": "Usability test team", "participants_1_description": "Tester are student of the computer science degree at the Luxembourg University. Using the backend generator from scratch with the documentation of BESSER (with a given PlantUML, library model)\n Using ChatGPT4o only giving the PlantUML model and no hand coding", "participants_1_size": 22, "participants_1_age": [20, 22], "participants_1_location": "University of Luxembourg", "participants_1_workplace": "Presential", "participants_1_ethnicities": "French", "participants_1_genders": "", "participants_1_disabilities": "", "participants_1_religious": "", "participants_1_type": ["Tester Team"], "participants_1_countries": [], "participants_1_edlevel": [], "participants_1_skills": [], "socialContext_targetCommunity_languages": ["French", "Luxembourgish-Letzeburgesch", "English"], "participants_0_languages": ["Spanish-Castilian", "English", "French"], "participants_1_languages": [], "governance_bodies_2_name": "", "governance_bodies_2_description": "", "governance_bodies_2_participant_name": "", "governance_bodies_2_participant_location": "", "governance_bodies_2_participant_workdplace": "Presential", "governance_bodies_2_participant_ethincity": "", "governance_bodies_2_participant_gender": "", "governance_bodies_2_participant_disabilities": "", "governance_bodies_2_participant_sexualOrientation": "", "governance_bodies_2_participant_religion": "", "governance_bodies_2_organization_name": "", "governance_bodies_2_organization_age": [10, 20], "governance_bodies_2_organization_location": "", "governance_bodies_2_organization_workplace": "Presential", "governance_bodies_2_organization_ethnicities": "", "governance_bodies_2_organization_genders": "", "governance_bodies_2_organization_disabilities": "", "governance_bodies_2_organization_religious": "", "governance_bodies_0_organization_countries": ["Luxembourg"]}
+{"master_title": "Besser", "master_desc": "BESSER (Better Software Faster) is a powerful low-code platform designed to streamline software development. Built on B-UML, our Python-based interpretation of a \"Universal Modeling Language\"\u2014inspired by and simplified from UML\u2014BESSER enables users to specify software applications efficiently. With B-UML, developers can define their application models and leverage built-in code generators to produce executable code for various frameworks, including Django models and SQLAlchemy-compatible database structures.", "governance_govProcesses": ["", ""], "governance_bodies": ["", ""], "usageContext_description": "Besser is inteded to be used by a broad community of app developers without the need of having coding skills.", "usageContext_targetCommunity": [""], "usageContext_adaptation": [""], "participants": ["", ""], "governance_projectType": ["public funded"], "governance_govProcesses_0": "BESSER is funded by the Luxembourg National Research Fund (FNR), the country\u2019s main agency for funding research across all scientific fields.", "governance_govProcesses_1": "The project is led by the recipient of the funds, its Principal Investigator.", "governance_bodies_0_name": "Funding programmes of the Luxembourg National Research Fund", "governance_bodies_0_description": "The Luxembourg National Research Fund (FNR, in French) is the main funding body for research in Luxembourg. The institution invests public funds and private donations into research projects in various branches of sciences and the humanities, with an emphasis on core strategic areas\n", "governance_bodies_0_participant_name": "", "governance_bodies_0_participant_location": "", "governance_bodies_0_participant_workdplace": "Presential", "governance_bodies_0_participant_ethincity": "", "governance_bodies_0_participant_gender": "", "governance_bodies_0_participant_disabilities": "", "governance_bodies_0_participant_sexualOrientation": "", "governance_bodies_0_participant_religion": "", "governance_bodies_0_organization_name": "Luxembourg\u2019s National Research Fund (FNR)", "governance_bodies_0_organization_age": [0, 99], "governance_bodies_0_organization_location": "Esch-sur-Alzette, Luxemburg", "governance_bodies_0_organization_workplace": "Presential", "governance_bodies_0_organization_ethnicities": "", "governance_bodies_0_organization_genders": "", "governance_bodies_0_organization_disabilities": "", "governance_bodies_0_organization_religious": "", "governance_bodies_0_type": ["funders"], "governance_bodies_1_name": "Principal Investigator", "governance_bodies_1_description": "The Principal investigator who is the recipients of the funds lead the project.", "governance_bodies_1_participant_name": "Jordi Cabot", "governance_bodies_1_participant_location": "", "governance_bodies_1_participant_workdplace": "Presential", "governance_bodies_1_participant_ethincity": "", "governance_bodies_1_participant_gender": "", "governance_bodies_1_participant_disabilities": "", "governance_bodies_1_participant_sexualOrientation": "", "governance_bodies_1_participant_religion": "", "governance_bodies_1_organization_name": "", "governance_bodies_1_organization_age": [10, 20], "governance_bodies_1_organization_location": "", "governance_bodies_1_organization_workplace": "Presential", "governance_bodies_1_organization_ethnicities": "", "governance_bodies_1_organization_genders": "", "governance_bodies_1_organization_disabilities": "", "governance_bodies_1_organization_religious": "", "governance_bodies_1_type": ["directors"], "governance_bodies_0_participant_age": 0, "governance_bodies_1_participant_age": 0, "usageContext_countries": ["France", "Luxembourg"], "usageContext_languages": ["French", "English"], "usageContext_targetCommunity_0_name": "Teacher and student of computer science", "usageContext_targetCommunity_0_description": "Teacher and student of computer science", "usageContext_targetCommunity_0_age": [18, 70], "usageContext_targetCommunity_0_location": "Luxembourg University", "usageContext_targetCommunity_0_workplace": "Presential", "usageContext_targetCommunity_0_ethnicities": "", "usageContext_targetCommunity_0_genders": "", "usageContext_targetCommunity_0_disabilities": "", "usageContext_targetCommunity_0_religious": "", "usageContext_targetCommunity_0_countries": ["Luxembourg"], "usageContext_targetCommunity_0_edlevel": ["bachelorEquivalent", "doctorateEquivalent"], "usageContext_targetCommunity_0_skills": ["beginner", "competent"], "usageContext_targetCommunity_0_languages": ["French"], "usageContext_adaptation_0_name": "Computer Science Teachers", "usageContext_adaptation_0_description": "The software have been adapted for its specific use in educational environments", "participants_0_name": "Development team", "participants_0_description": "The development team of Besser is composed of a geographical diversity team based on Luxemboug.", "participants_0_size": 16, "participants_0_age": [24, 45], "participants_0_location": "Esch-sur-Alzette, Luxemburg", "participants_0_workplace": "Presential", "participants_0_ethnicities": "Colombian,Brasilian, Argentinian, French ,Spanish, Pakistani, Serbian, Iranian, Morroco, Italian", "participants_0_genders": "80% male, 20% famela", "participants_0_disabilities": "", "participants_0_religious": "", "participants_0_type": ["Development Team"], "participants_0_countries": ["Colombia", "Spain", "Pakistan", "Iran,IslamicRepublicof", "Argentina", "Brazil", "Serbia"], "participants_0_edlevel": ["masterEquivalent", "doctorateEquivalent"], "participants_0_skills": ["proficient", "advanced"], "participants_0_languages": ["Spanish-Castilian", "Catalan-Valencian", "English", "French"], "participants_1_name": "Usability test team", "participants_1_description": "An usability test team have been conducted with a crowd of users. Tester are student of the computer science degree at the Luxembourg University. Using the backend generator from scratch with the documentation of BESSER (with a given PlantUML, library model)\\n Using ChatGPT4o only giving the PlantUML model and no hand coding", "participants_1_size": 0, "participants_1_age": [22, 24], "participants_1_location": "University of Luxembourg", "participants_1_workplace": "Presential", "participants_1_ethnicities": "", "participants_1_genders": "", "participants_1_disabilities": "", "participants_1_religious": "", "participants_1_type": ["Tester Team"], "participants_1_countries": ["Luxembourg"], "participants_1_skills": ["beginner", "competent"], "participants_1_languages": ["Luxembourgish-Letzeburgesch"]}

markdownGenerator.py

@@ -1,8 +1,14 @@
 def generate_markdown(state):
+
+
+###############################
+## Start Summary
+###############################
     html_str= f"""
 # The Software diversity card of {state["master"]["title"]}
 {state["master"]["desc"]} 
-## 🏢 Teams Summary
+
+## :busts_in_silhouette: Teams Summary
 
 <table>
 <tr>
@@ -10,13 +16,12 @@ def generate_markdown(state):
     <th>Description</th>
     <th>Type</th>
     <th>Age Range</th>
-    <th>Ethnicities</th>
-    <th>Genders</th>
     <th>Team Size</th>
     <th>Location</th>
 </tr>"""
-    ## If development team addit
-    if 'participants' in state:
+    
+    ## Participants
+    if 'participants' in state and isinstance(state['participants'], dict):
         for key, participant in state['participants'].items():
             if participant['name']:
                     description = participant['description'].replace('\\n', '')
@@ -32,28 +37,27 @@ def generate_markdown(state):
 
             html_str = html_str + f"""    
         <td>{participant['age'][0]}-{participant['age'][1]}</td>
-        <td>{participant['ethnicities']}</td>
-        <td>{participant['genders']}</td>
         <td>{participant['size']}</td>
         <td>{participant['location']}</td>
     </tr>"""
-        ## If target Communities add it
-    if state['socialContext']['targetCommunity']['name']:
-                        description = state['socialContext']['targetCommunity']['description'].replace('\\n', '')
-                        html_str = html_str + f"""     
+        
+    ## If target Communities add it
+    if 'targetCommunity' in state['usageContext'] and isinstance(state['usageContext']['targetCommunity'], dict):
+        for key, targetCommunity in state['usageContext']['targetCommunity'].items():
+            if targetCommunity['name']:
+                    description = targetCommunity['description'].replace('\\n', '')
+                    html_str = html_str + f"""     
 <tr>
-<td><strong>{state['socialContext']['targetCommunity']['name']}</strong></td>
+<td><strong>{targetCommunity['name']}</strong></td>
     <td>{description}</td>
     <td> Targeted Community </td>
-    <td>{state['socialContext']['targetCommunity']['age'][0]}-{state['socialContext']['targetCommunity']['age'][1]}</td>
-    <td>{state['socialContext']['targetCommunity']['ethnicities']}</td>
-    <td>{state['socialContext']['targetCommunity']['genders']}</td>
+    <td>{targetCommunity['age'][0]}-{targetCommunity['age'][1]}</td>
     <td> many </td>
-    <td>{state['socialContext']['targetCommunity']['location']}</td>
+    <td>{targetCommunity['location']}</td>
 </tr>"""
     ## If bodies add 
     if 'governance' in state:
-        if 'bodies' in state['governance']:
+        if 'bodies' in state['governance'] and isinstance(state['governance']['bodies'], dict):
             for key, body in state['governance']["bodies"].items():
                 if body['name']:
                     description = body['description'].replace('\\n', '')
@@ -65,26 +69,260 @@ def generate_markdown(state):
                     html_str = html_str + f"""<td>{body['type'][0]}</td>"""
                 else:
                     html_str = html_str + f"""<td> </td>"""
-                if body['organization']['name']:
-                    html_str = html_str + f""" 
-        <td>{body['organization']['age'][0]}-{body['organization']['age'][1]}</td>
-        <td>{body['organization']['ethnicities']}</td>
-        <td>{body['organization']['genders']}</td>
-        <td> - </td>
-        <td>{body['organization']['location']}</td>
-        </tr>"""    
-            
-                if body['participant']['name']:
+                if 'organization' in body:
+                    if body['organization']['name']:
                         html_str = html_str + f""" 
-        <td>45</td> 
-        <td>{body['participant']['ethincity']}</td>
-        <td>{body['participant']['gender']}</td>
-        <td> - </td>
-        <td>{body['participant']['location']}</td>
-        </tr>"""
+            <td>{body['organization']['age'][0]}-{body['organization']['age'][1]}</td>
+            <td> - </td>
+            <td>{body['organization']['location']}</td>
+            </tr>"""    
+                if 'participant' in body:
+                    if body['participant']['name']:
+                            html_str = html_str + f""" 
+            <td>{body['participant']['age']}</td> 
+            <td> - </td>
+            <td>{body['participant']['location']}</td>
+            </tr>"""
         
     ## End summary
     html_str = html_str + f"   </table>"
 
-                   
-    return html_str
+###############################
+## Start Governance
+###############################
+    html_str = html_str + f"""
+
+## 🏢 Governance
+    
+    """
+    if 'governance' in state:
+        if 'govProcesses' in state['governance'] and isinstance(state['governance']['govProcesses'], dict):
+            for key, text in state['governance']["govProcesses"].items():
+                  html_str = html_str + f"""
+### Governance processes
+
+**Process**: {text} 
+"""
+        if 'projectType' in state['governance']:
+            html_str = html_str + f"""
+
+**Type:** {pretty_list(state['governance']['projectType'])}
+"""
+            
+      
+        if 'bodies' in state['governance'] and isinstance(state['governance']['bodies'], dict):
+            for key, body in state['governance']["bodies"].items():
+                if body['name']:
+                    description = body['description'].replace('\\n', '')
+                    html_str = html_str + f"""     
+   
+#### **{body['name']}**
+
+**Description:** {description}
+
+"""
+                if 'type' in body:
+                    html_str = html_str + f"""
+**Type:** {body['type'][0]} 
+
+""" 
+                if body['organization']['name']:
+                    html_str = html_str + f""" 
+**Organization:** {body['organization']['name']} 
+"""
+                if body['organization']['location']:
+                    html_str = html_str + f""" 
+**Location:** {body['organization']['location']} 
+
+"""
+                if body['organization']['age']:
+                    html_str = html_str + f""" 
+**Age range:** {body['organization']['age'][0]}-{body['organization']['age'][1]} 
+
+"""
+                if body['organization']['ethnicities']:
+                    html_str = html_str + f""" 
+**Ethnicities:** {body['organization']['ethnicities']} 
+"""
+                if body['organization']['genders']:
+                    html_str = html_str + f""" 
+
+**Genders:** {body['organization']['genders']} 
+
+"""
+                if 'languages' in body['organization']:
+                       html_str = html_str + f""" 
+**Languages:** {pretty_list(body['organization']['languages'])} 
+
+"""
+
+            
+                if body['participant']['name']:
+                         html_str = html_str + f""" 
+**Organization:** {body['participant']['name']}
+"""
+                if body['participant']['location']:  
+                     html_str = html_str + f""" 
+**Location:** {body['participant']['location']}
+
+"""
+                if body['participant']['age']:  
+                     html_str = html_str + f"""     
+**Age range:** {body['participant']['age']}
+
+"""
+                if body['participant']['ethincity']:  
+                     html_str = html_str + f""" 
+**Ethnicities:** {body['participant']['ethincity']}
+
+"""
+                if body['participant']['gender']:  
+                     html_str = html_str + f""" 
+**Genders:** {body['participant']['gender']}
+
+"""
+                if 'languages' in body['participant']:
+                    html_str = html_str + f""" 
+** Languages: ** {pretty_list(body['participant']['languages'])}
+
+"""
+                    
+###############################
+## Start Usage Context
+###############################
+    if 'usageContext' in state:
+        html_str = html_str + f"""
+
+## :twisted_rightwards_arrows: Usage Context
+    
+"""
+        if 'description' in state['usageContext']:
+            html_str = html_str + f"""
+
+**Description:** {state['usageContext']['description']}
+
+"""
+        if 'countries' in state['usageContext']:
+             html_str = html_str + f"""
+**Countries:** {pretty_list(state['usageContext']['countries'])}
+
+"""
+        if 'languages' in state['usageContext']:
+            html_str = html_str + f"""
+**Languages:** {pretty_list(state['usageContext']['languages'])}
+
+"""
+        if 'targetCommunity' in state['usageContext'] and isinstance(state['usageContext']['targetCommunity'], dict):        
+            for key, targetCommunity in state['usageContext']['targetCommunity'].items():
+            
+              if 'name' in targetCommunity:
+                html_str = html_str + f"""
+#### Target Community: {targetCommunity['name']}
+
+"""
+              if 'description' in targetCommunity:
+                html_str = html_str + f"""
+**Description:** {targetCommunity['description']}
+
+"""
+              if 'age' in targetCommunity:
+                 html_str = html_str + f""" 
+**Age range:** {targetCommunity['age']}
+"""
+              if 'location' in targetCommunity:
+                html_str = html_str + f""" 
+**Location:** {targetCommunity['location']}
+
+"""
+        if 'adaptation' in state['usageContext'] and isinstance(state['usageContext']['adaptation'], dict):        
+            for key, adaptation in state['usageContext']['adaptation'].items():
+                if 'name' in adaptation:
+                    html_str = html_str + f""" 
+#### Adaptation: **{adaptation['name']}**
+
+"""
+                if 'description' in adaptation:
+                    html_str = html_str + f""" 
+{adaptation['description']}
+
+"""
+                    
+
+###############################
+## Start Participants
+###############################
+    if 'participants' in state:
+        html_str = html_str + f"""
+
+## :hammer_and_wrench: Participants     
+
+"""
+      ## Participants
+        if isinstance(state['participants'], dict):
+            for key, participant in state['participants'].items():
+                if 'name' in participant:
+                    html_str = html_str + f""" 
+### {participant['name']}
+
+"""
+                if 'description' in participant:
+                    html_str = html_str + f""" 
+**Description:** {participant['description']}
+
+"""
+                if 'type' in participant:
+                    html_str = html_str + f""" 
+**Type:** {pretty_list(participant['type'])}
+
+"""
+                if 'size' in participant:
+                    html_str = html_str + f""" 
+**Size:** {participant['size']}
+
+"""
+                if 'location' in participant:
+                    html_str = html_str + f""" 
+**Location:** {participant['location']}
+
+"""
+                if 'workplace' in participant:
+                    html_str = html_str + f""" 
+**Workplace:** {participant['workplace']}
+
+"""
+                if 'ethnicitise' in participant:
+                    html_str = html_str + f""" 
+**Ethnicitise:** {participant['ethnicitise']}
+
+"""
+                if 'genders' in participant:
+                    html_str = html_str + f""" 
+**Genders:** {participant['genders']}
+
+"""
+                if 'countries' in participant:
+                    html_str = html_str + f""" 
+**Countries:** {pretty_list(participant['countries'])}
+
+"""
+                if 'edlevel' in participant:
+                    html_str = html_str + f""" 
+**Educational level:** {pretty_list(participant['edlevel'])}
+
+"""
+                if 'skills' in participant:
+                    html_str = html_str + f""" 
+**Skills level:** {pretty_list(participant['skills'])}
+
+"""
+                if 'languages' in participant:
+                    html_str = html_str + f""" 
+**Languages Spoken:** {pretty_list(participant['languages'])}
+
+"""
+
+
+    return html_str
+
+def pretty_list(list):
+    return ', '.join(list)

sdc_view.py

@@ -171,12 +171,12 @@ def render_sdc():
             # Initialize session state for the number input if it doesn't exist
             agekey = f"{key}_age"
             if  agekey not in st.session_state:
-                st.session_state[agekey] = 0  # default value
+                st.session_state.form_data[agekey] = 0  # default value
             # Display a number input widget
             st.number_input(
                 label="The age of the participant:",
                 key=agekey,
-                on_change=lambda: (st.session_state.form_data.update({key: st.session_state[agekey]}), save_to_cache())[1]
+                on_change=lambda: (st.session_state.form_data.update({agekey: st.session_state[agekey]}), save_to_cache())[1]
             )
             cached_text_input("Location", f"{key}_location", "The title of the card")
             cached_radio_input("WorkplaceType", ["Presential", "Hybrid", "Remote"],  f"{key}_workdplace", "The title of the card")
@@ -489,7 +489,7 @@ def render_sdc():
                 mime="text/markdown"
             )
             st.text("Preview:")
-            #st.markdown(generate_markdown(unflattenedJson), unsafe_allow_html=True)
+            st.markdown(generate_markdown(unflattenedJson), unsafe_allow_html=True)
     with jsonTab:
 
             # Convert the session state to a JSON string