now it is possible to add details via the UI

app.py

@@ -2,15 +2,17 @@ import re
 from enum import Enum
 
 import streamlit as st
+import streamlit_tags as st_tags
 from streamlit import session_state as ss
+from streamlit.delta_generator import DeltaGenerator
 from streamlit.runtime.scriptrunner_utils.exceptions import StopException
 
 from form.form import build_form_data_from_answers, write_pdf_form, work_categories
 from llm_manager.llm_parser import LlmParser
-from local_storage.entities import PersonalDetails, LocationDetails, ContractorDetails
+from local_storage.entities import PersonalDetails, LocationDetails, ContractorDetails, SavedDetails
 from local_storage.ls_manager import LocalStorageManager
 from prompts.prompts_manager import PromptsManager
-from enums import Questions as Q
+from enums import Questions as Q, DetailsType
 from repository.repository import build_repo_from_environment, get_repository
 from repository import ModelRoles, Model
 from utils.parsing_utils import check_for_missing_answers
@@ -19,6 +21,7 @@ user_msg = "Please describe what you need to do. To get the best results try to
 
 find_tags_regex = re.compile(r"@(\S*)")
 
+
 class Steps(Enum):
  INITIAL_STATE = 1
  PARSING_ANSWERS = 2
@@ -44,7 +47,9 @@ class UIManager:
  get_repository("testing",
  Model("fakeModel",
  ModelRoles("a", "b", "c"))))
+ self.update_in_progress = False
  self.lsm = None
+
  @staticmethod
  def get_current_step() -> int:
  try:
@@ -56,28 +61,33 @@ class UIManager:
  def set_current_step(step: Steps):
  ss["step"] = step.value
 
- @staticmethod
- def _build_base_ui():
+ def _build_base_ui(self):
  st.markdown("## Dubai Asset Management red tape cutter")
+ self.lsm = LocalStorageManager() if not self.lsm else self.lsm
+ with st.sidebar:
+ st.markdown("### Personal details")
+ self.build_details_checkboxes(DetailsType.PERSONAL_DETAILS)
+ st.markdown("### Locations details")
+ self.build_details_checkboxes(DetailsType.LOCATION_DETAILS)
+ st.markdown("### Contractors details")
+ self.build_details_checkboxes(DetailsType.CONTRACTOR_DETAILS)
 
  def build_ui_for_initial_state(self, user_message):
  help_ = user_message + "\n".join(self.pm.questions)
  self._build_base_ui()
  with st.form("Please describe your request"):
- user_input = st.text_area("Your input", height=700, label_visibility="hidden", placeholder=help_,
- help=help_)
- signature = st.file_uploader("Your signature", key="file_upload")
- ss["signature"] = signature
- submit_button = st.form_submit_button()
- if submit_button:
- ss["user_input"] = user_input
- self.set_current_step(Steps.PARSING_ANSWERS)
- st.rerun()
+ st.text_area("Your input", height=700, label_visibility="hidden", placeholder=help_,
+ help=help_, key="user_input")
+ signature = st.file_uploader("Your signature", key="file_upload")
+ ss["signature"] = signature
+ submit_button = st.form_submit_button()
+ if submit_button:
+ self.set_current_step(Steps.PARSING_ANSWERS)
+ st.rerun()
 
  def build_ui_for_parsing_answers(self):
  self._build_base_ui()
  with st.status("parsing user input for tags"):
- self.lsm = LocalStorageManager() if not self.lsm else self.lsm
  tags = find_tags_regex.findall(ss["user_input"])
  details = [self.lsm.get_detail(t) for t in tags]
  with st.status("initialising LLM"):
@@ -165,12 +175,12 @@ class UIManager:
  self._build_validation_form(True, self._create_pdf_form,
  "Create work permit request")
 
-
  @staticmethod
  def _get_personal_details(personal_details_key) -> PersonalDetails | None:
  key_ = ss.get(personal_details_key)
  if key_:
- details = PersonalDetails(ss[f"fq_{Q.FULL_NAME.name}"], ss[f"fq_{Q.YOUR_EMAIL.name}"], ss[f"fq_{Q.CONTACT_NUMBER.name}"])
+ details = PersonalDetails(ss[f"fq_{Q.FULL_NAME.name}"], ss[f"fq_{Q.YOUR_EMAIL.name}"],
+ ss[f"fq_{Q.CONTACT_NUMBER.name}"])
  return details
  return None
 
@@ -188,9 +198,7 @@ class UIManager:
  ss[f"fq_{Q.COMPANY_EMAIL.name}"])
  return None
 
-
-
- def _build_validation_form(self, show_categories:bool, onsubmit, submit_button_label):
+ def _build_validation_form(self, show_categories: bool, onsubmit, submit_button_label):
  def build_form_fragment(form_, col, title, add_save, *questions):
  form_.text(title)
  for user_data in questions:
@@ -206,7 +214,7 @@ class UIManager:
  col1, col2 = f.columns(2)
  build_form_fragment(f, col1, "your details", True, Q.FULL_NAME, Q.CONTACT_NUMBER, Q.YOUR_EMAIL)
  build_form_fragment(f, col2, "work details", False, Q.WORK_TO_DO, Q.START_DATE, Q.END_DATE)
- build_form_fragment(f, col1, "location details", True, Q.COMMUNITY, Q.BUILDING, Q.UNIT_APT_NUMBER,
+ build_form_fragment(f, col1, "location details", True, Q.COMMUNITY, Q.BUILDING, Q.UNIT_APT_NUMBER,
  Q.OWNER_OR_TENANT)
  build_form_fragment(f, col2, "contractor details", True, Q.COMPANY_NAME, Q.COMPANY_NUMBER, Q.COMPANY_EMAIL)
  if show_categories:
@@ -217,12 +225,69 @@ class UIManager:
  if submit_data:
  onsubmit()
 
+ def build_details_checkboxes(self, dt: DetailsType):
+ details = self.lsm.get_details(dt)
+ with st.container(border=True):
+ col1, col2 = st.columns(2)
+ with col1:
+ st.markdown(f"#### {dt.title()}")
+ with col2:
+ st.markdown("#### Default")
+ for d in details:
+ with col1:
+ st.checkbox(label=d.short_description(), key=f"{dt.name}_{d.key}",
+ on_change=self._update_user_prompt, args=[dt, d.key])
+ with col2:
+ st.toggle(f"favourite_{d.key}", label_visibility="hidden", value=ss.get(f"DEFAULT_{dt.name}"))
+ add_new = st.button(f"Add {dt.title()}")
+ if add_new:
+ self.add_new_detail_dialog(dt)
+
+ @st.dialog("Add new")
+ def add_new_detail_dialog(self, type_: DetailsType):
+ if type_.name == DetailsType.CONTRACTOR_DETAILS.name:
+ new_item = ContractorDetails()
+ elif type_.name == DetailsType.PERSONAL_DETAILS.name:
+ new_item = PersonalDetails()
+ else:
+ new_item = LocationDetails()
+ with st.form("new item", border=False):
+ fields_labels = new_item.widget_labels()
+ for k,v in fields_labels.items():
+ st.text_input(label=v, key=k)
+ btn_save = st.form_submit_button("Save")
+ if btn_save:
+ for k in fields_labels:
+ setattr(new_item, k, ss[k])
+ self.lsm.save_details(new_item)
+ st.rerun()
+ def _update_user_prompt(self, type_: DetailsType, key: str):
+ if not self.update_in_progress:
+ self.update_in_progress = True
+ checkbox_key = f"{type_.name}_{key}"
+ if ss.get(checkbox_key) is True:
+ # if the checkbox is _selected_
+ to_deselect = [d for d in self.lsm.get_details(type_) if d.key != key]
+ for td in to_deselect:
+ # deselect other checkbox in the same type
+ ss[f"{type_.name}_{td}"] = False
+ if f"@{td}" in ss.get("user_input"):
+ # remove the key associated with this checkbox from the user input textarea
+ ss["user_input"] = ss.get["user_input"].replace(f"@{td}", "")
+ # add the key associated to the newly selected checkbox in the user input textarea
+ ss["user_input"] = f"{ss.get('user_input', '')} @{key}".strip()
+ else:
+ # remove the key associated to the newly deselected checkbox in the user input textarea
+ if f"@{key}" in ss.get("user_input"):
+ ss["user_input"] = ss.get("user_input", "").replace(f"@{key}", "").strip()
+ self.update_in_progress = False
+
 
 um = UIManager()
 
-def use_streamlit():
 
- if um.get_current_step() == Steps.INITIAL_STATE.value :
+def use_streamlit():
+ if um.get_current_step() == Steps.INITIAL_STATE.value:
  um.build_ui_for_initial_state(user_msg)
  elif um.get_current_step() == Steps.PARSING_ANSWERS.value:
  um.build_ui_for_parsing_answers()

enums.py

@@ -1,16 +1,6 @@
 from enum import Enum
 
 
-class DetailsType(Enum):
- PERSONAL_DETAILS = 1
- LOCATION_DETAILS = 2
- CONTRACTOR_DETAILS = 3
-
- @classmethod
- def values(cls):
- return [cls.PERSONAL_DETAILS, cls.LOCATION_DETAILS, cls.CONTRACTOR_DETAILS]
-
-
 class Questions(Enum):
  FULL_NAME = 0
  WORK_TO_DO = 1
@@ -30,4 +20,17 @@ class Questions(Enum):
  def values(cls):
  return [Questions.FULL_NAME, Questions.WORK_TO_DO, Questions.BUILDING, Questions.UNIT_APT_NUMBER,
  Questions.OWNER_OR_TENANT, Questions.START_DATE, Questions.END_DATE, Questions.CONTACT_NUMBER,
- Questions.COMPANY_NAME, Questions.COMPANY_EMAIL, Questions.COMPANY_NUMBER, Questions.YOUR_EMAIL]
+ Questions.COMPANY_NAME, Questions.COMPANY_EMAIL, Questions.COMPANY_NUMBER, Questions.YOUR_EMAIL]
+
+
+class DetailsType(Enum):
+ PERSONAL_DETAILS = 1
+ LOCATION_DETAILS = 2
+ CONTRACTOR_DETAILS = 3
+
+ def title(self):
+ return self.name.replace("_", " ").lower()
+
+ @classmethod
+ def values(cls):
+ return [cls.PERSONAL_DETAILS, cls.LOCATION_DETAILS, cls.CONTRACTOR_DETAILS]

local_storage/entities.py

@@ -1,13 +1,14 @@
 import abc
 
-from enums import DetailsType, Questions
+from enums import Questions, DetailsType
 
 
 class SavedDetails(abc.ABC):
-
  excluded_fields = ["type_"]
- def __init__(self, type_: DetailsType):
+
+ def __init__(self, type_: DetailsType, key: str = None):
  self.type_ = type_
+ self.key = key
 
  @classmethod
  def load(cls, data: dict):
@@ -17,16 +18,26 @@ class SavedDetails(abc.ABC):
  return cls.__init__(**{k: v for k, v in data if k != "type"})
 
  def to_json(self):
- return {k:v for k,v in self.__dict__.items() if k not in self.excluded_fields}
+ self.key = self.key.replace(" ", "_")
+ return {k: v for k, v in self.__dict__.items() if k not in self.excluded_fields}
 
  def to_answers(self):
  pass
 
+ def short_description(self):
+ return ", ".join([v for k, v in self.__dict__.items() if k not in self.excluded_fields])
+
+ def widget_labels(self) -> dict[str, str]:
+ fields = {k: " ".join(k.title().split("_")) for k in self.__dict__
+ if k not in self.excluded_fields and k != "key"}
+ fields["key"] = "Save as"
+ return fields
+
+
 class PersonalDetails(SavedDetails):
- type_ = DetailsType.PERSONAL_DETAILS
 
- def __init__(self, full_name, email, contact_number, *_):
- super().__init__(self.type_)
+ def __init__(self, key: str = None, full_name: str = None, email: str = None, contact_number: str = None, *_):
+ super().__init__(DetailsType.PERSONAL_DETAILS, key)
  self.full_name = full_name
  self.email = email
  self.contact_number = contact_number
@@ -41,11 +52,13 @@ class PersonalDetails(SavedDetails):
  answers[Questions.CONTACT_NUMBER] = self.contact_number
  return answers
 
+
 class LocationDetails(SavedDetails):
  type_ = DetailsType.LOCATION_DETAILS
 
- def __init__(self, owner_or_tenant: str, community: str, building: str, unit_number: str, *_):
- super().__init__(self.type_)
+ def __init__(self, owner_or_tenant: str = None, community: str = None, building: str = None,
+ unit_number: str = None, key: str = None, *_):
+ super().__init__(self.type_, key)
  self.owner_or_tenant = owner_or_tenant
  self.community = community
  self.building = building
@@ -63,11 +76,13 @@ class LocationDetails(SavedDetails):
  answers[Questions.UNIT_APT_NUMBER] = self.unit_number
  return answers
 
+
 class ContractorDetails(SavedDetails):
  type_ = DetailsType.CONTRACTOR_DETAILS
 
- def __init__(self, contractor_name: str, contractor_contact_number: str, contractor_email: str, *_):
- super().__init__(self.type_)
+ def __init__(self, contractor_name: str = None, contractor_contact_number: str = None, contractor_email: str = None,
+ key: str = None, *_):
+ super().__init__(self.type_, key)
  self.contractor_name = contractor_name
  self.contractor_contact_number = contractor_contact_number
  self.contractor_email = contractor_email
@@ -80,4 +95,4 @@ class ContractorDetails(SavedDetails):
  answers[Questions.COMPANY_NUMBER] = self.contractor_contact_number
  if self.contractor_name is not None:
  answers[Questions.COMPANY_NAME] = self.contractor_name
- return answers
+ return answers

local_storage/ls_manager.py

@@ -8,7 +8,7 @@ class LocalStorageManager:
  def __init__(self):
  self.ls: LocalStorage = LocalStorage()
 
- def get_detail(self, key: str):
+ def get_detail(self, key: str = None):
  for detail_type in DetailsType.values():
  detail = self.ls.getItem(detail_type.name).get(key)
  if detail:
@@ -21,7 +21,7 @@ class LocalStorageManager:
  return None
  return None
 
- def save_details(self, details: SavedDetails, key: str):
+ def save_details(self, details: SavedDetails):
  if isinstance(details, PersonalDetails):
  type_ = DetailsType.PERSONAL_DETAILS
  elif isinstance(details, LocationDetails):
@@ -31,8 +31,15 @@ class LocalStorageManager:
  else:
  raise ValueError("Unexpected type: {}", type(details))
  existing_data = (self.ls.getItem(type_.name) or {})
- existing_data[key] = details.to_json()
+ existing_data[details.key] = details.to_json()
  self.ls.setItem(type_.name, existing_data, type_.name)
 
- def get_details(self, type_: DetailsType):
- return self.ls.getItem(type_.name) or {}
+ def get_details(self, type_: DetailsType) -> list[SavedDetails]:
+ if type_.value == DetailsType.PERSONAL_DETAILS.value:
+ cls = PersonalDetails
+ elif type_.value == DetailsType.LOCATION_DETAILS.value:
+ cls = LocationDetails
+ else:
+ cls = ContractorDetails
+ details = self.ls.getItem(type_.name) or {}
+ return [cls(**v) for k,v in details.items()]

requirements-base.txt

@@ -1,4 +1,5 @@
 transformers
 streamlit
 PyPDFForm
-streamlit-local-storage
+streamlit-local-storage
+streamlit-tags