docassemble.AssemblyLine 4.1.0__tar.gz → 4.3.0__tar.gz

{docassemble_assemblyline-4.1.0/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-4.3.0}/PKG-INFO

@@ -1,22 +1,19 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.1.0
+Version: 4.3.0
+Summary: Quickly go from a paper court form to a runnable, guided, step-by-step web application powered by Docassemble. Swap out branding and pre-built questions to meet your needs.
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
-Author-email: qsteenhuis@suffolk.edu
-License: The MIT License (MIT)
+Author-email: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
+License-Expression: MIT
+Project-URL: Homepage, https://courtformsonline.org
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: docassemble.ALToolbox>=0.12.0
-Requires-Dist: docassemble.GithubFeedbackForm>=0.4.1.1
+Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
 Dynamic: author
-Dynamic: author-email
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-dist
 
 # Suffolk LIT Lab Document Assembly Line
 
@@ -55,7 +52,7 @@ https://suffolklitlab.org/docassemble-AssemblyLine-documentation/
 
 ## Menu-driven installation
 
-The recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).
+The recommended installation method is with the [guided installation script](https://assemblyline.suffolklitlab.org/docs/get_started/installation).
 
 ## Manual installation
 
@@ -155,3 +152,4 @@ code: |
 # Changelog
 
 See [CHANGELOG.MD](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)
+

{docassemble_assemblyline-4.1.0 → docassemble_assemblyline-4.3.0}/README.md

@@ -35,7 +35,7 @@ https://suffolklitlab.org/docassemble-AssemblyLine-documentation/
 
 ## Menu-driven installation
 
-The recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).
+The recommended installation method is with the [guided installation script](https://assemblyline.suffolklitlab.org/docs/get_started/installation).
 
 ## Manual installation
 
@@ -135,3 +135,4 @@ code: |
 # Changelog
 
 See [CHANGELOG.MD](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)
+

docassemble_assemblyline-4.3.0/docassemble/AssemblyLine/__init__.py

@@ -0,0 +1 @@
+__version__ = '4.3.0'

{docassemble_assemblyline-4.1.0 → docassemble_assemblyline-4.3.0}/docassemble/AssemblyLine/al_courts.py

@@ -3,7 +3,7 @@ Package for a very simple / MVP list of courts that is mostly signature compatib
 """
 
 import os
-from typing import Any, Callable, Dict, List, Mapping, Optional, Union, Set
+from typing import Any, Callable, Dict, List, Mapping, Optional, Union, Set, Tuple
 import pandas as pd
 import docassemble.base.functions
 from docassemble.base.util import (
@@ -238,12 +238,12 @@ class ALCourtLoader(DAObject):
     # Only solution I can think of would require court database owners to assign each court a unique ID
     # and something that triggers recalculating the court address/etc info.
 
-    def all_courts(self) -> List[Dict[int, str]]:
+    def all_courts(self) -> List[Tuple[int, str]]:
         """
         Return a list of all courts in the spreadsheet.
 
         Returns:
-            List[Dict[int, str]]: List of all ALCourt instances without filtering.
+            List[Tuple[int, str]]: List of tuples where each tuple contains (dataframe_index, display_value). The dataframe_index (int) can be used with as_court() to retrieve the full court object. The display_value (str) is the court's name or other display column value.
         """
         return self.filter_courts(None)
 
@@ -329,13 +329,14 @@ class ALCourtLoader(DAObject):
         display_column: str = "name",
         search_string: Optional[str] = None,
         search_columns: Optional[Union[List[str], str]] = None,
-    ) -> List[Dict[int, str]]:
+    ) -> List[Tuple[int, str]]:
         """
         Retrieve a list of all courts in the specified county.
 
         This function fetches courts suitable for displaying as a drop-down or radio button list
-        in Docassemble. The results are dictionaries where the key is the index in the dataframe,
-        useful for retrieving the court's full details later using the as_court() method.
+        in Docassemble. The results are tuples where the first element is the dataframe index
+        (useful for retrieving the court's full details later using the as_court() method) and
+        the second element is the display value from the specified display_column.
 
         Args:
             county_name (str): Name of the county.
@@ -346,7 +347,7 @@ class ALCourtLoader(DAObject):
                 the search_string in a case-insensitive manner. Defaults to None.
 
         Returns:
-            List[Dict[int, str]]: List of dictionaries representing matching courts.
+            List[Tuple[int, str]]: List of tuples where each tuple contains (dataframe_index, display_value). The dataframe_index (int) can be used with as_court() to retrieve the full court object. The display_value (str) is the court's name or other display column value.
         """
         return self.filter_courts(
             court_types=county_name,
@@ -363,11 +364,11 @@ class ALCourtLoader(DAObject):
         display_column: str = "name",
         search_string: Optional[str] = None,
         search_columns: Optional[Union[List[str], str]] = None,
-    ) -> List[Dict[int, str]]:
+    ) -> List[Tuple[int, str]]:
         """
-        Return a filtered subset of courts represented as a list of dictionaries.
+        Return a filtered subset of courts represented as a list of tuples.
 
-        Each dictionary has the format {index: name}, where "index" refers to the dataframe index and "name"
+        Each tuple has the format (index, display_value), where "index" refers to the dataframe index and "display_value"
         is determined by the `display_column`.
 
         Args:
@@ -380,7 +381,7 @@ class ALCourtLoader(DAObject):
                 the search_string in a case-insensitive manner. Defaults to None.
 
         Returns:
-            List[Dict[int, str]]: List of dictionaries representing filtered courts.
+            List[Tuple[int, str]]: List of tuples where each tuple contains (dataframe_index, display_value). The dataframe_index (int) can be used with as_court() to retrieve the full court object. The display_value (str) is the court's name or other display column value.
         """
         df = self._load_courts()
         if court_types:

{docassemble_assemblyline-4.1.0 → docassemble_assemblyline-4.3.0}/docassemble/AssemblyLine/al_document.py

@@ -12,6 +12,7 @@ from docassemble.base.util import (
     DAFile,
     DAFileCollection,
     DAFileList,
+    DALazyTemplate,
     defined,
     pdf_concatenate,
     zip_file,
@@ -28,6 +29,7 @@ from docassemble.base.util import (
     DAStaticFile,
     alpha,
     showifdef,
+    word,
 )
 from docassemble.base.pdfa import pdf_to_pdfa
 from textwrap import wrap
@@ -39,7 +41,6 @@ from typing import Tuple
 import secrets
 import string
 
-
 __all__ = [
     "ALAddendumField",
     "ALAddendumFieldDict",
@@ -315,6 +316,9 @@ class ALAddendumField(DAObject):
 
         # If trigger is not a boolean value, overflow value is the value that starts at the end of the safe value.
         original_value = self.value_if_defined()
+        # Ensure a DALazyTemplate is rendered to a string for downstream string ops
+        if isinstance(original_value, DALazyTemplate):
+            original_value = str(original_value)
         safe_text = self.safe_value(
             overflow_message=overflow_message,
             input_width=input_width,
@@ -409,6 +413,9 @@ class ALAddendumField(DAObject):
             val = _original_value
         else:
             val = self.value_if_defined()
+        # If this is a template block, render it now so comparisons work correctly
+        if isinstance(val, DALazyTemplate):
+            val = str(val)
 
         return (
             self.safe_value(
@@ -508,6 +515,11 @@ class ALAddendumField(DAObject):
             value = _original_value
         else:
             value = self.value_if_defined()
+
+        # Convert template blocks to strings for purposes of evaluating overflow
+        if isinstance(value, DALazyTemplate):
+            value = str(value)
+
         if (
             isinstance(value, str)
             and len(value) <= self.overflow_trigger
@@ -1996,11 +2008,11 @@ class ALDocumentBundle(DAList):
         refresh: bool = True,
         pdfa: bool = False,
         include_zip: bool = True,
-        view_label="View",
+        view_label: Optional[str] = None,
         view_icon: str = "eye",
-        download_label: str = "Download",
+        download_label: Optional[str] = None,
         download_icon: str = "download",
-        send_label: str = "Send",
+        send_label: Optional[str] = None,
         send_icon: str = "envelope",
         zip_label: Optional[str] = None,
         zip_icon: str = "file-archive",
@@ -2023,11 +2035,11 @@ class ALDocumentBundle(DAList):
             refresh (bool): Flag to reconsider the 'enabled' attribute, default is True.
             pdfa (bool): Flag to return documents in PDF/A format, default is False.
             include_zip (bool): Flag to include a zip option, default is True.
-            view_label (str): Label for the 'view' button, default is "View".
+            view_label (str): Label for the 'view' button, default is self.view_label or "View".
             view_icon (str): Icon for the 'view' button, default is "eye".
-            download_label (str): Label for the 'download' button, default is "Download".
+            download_label (str): Label for the 'download' button, default is self.download_label or "Download".
             download_icon (str): Icon for the 'download' button, default is "download".
-            send_label (str): Label for the 'send' button. Default is "Send".
+            send_label (str): Label for the 'send' button. Default is self.send_label or "Send".
             send_icon (str): Fontawesome icon for the 'send' button. Default is "envelope".
             zip_label (Optional[str]): Label for the zip option. If not provided, uses the generic template for `self.zip_label` ("Download all").
             zip_icon (str): Icon for the zip option, default is "file-archive".
@@ -2044,11 +2056,14 @@ class ALDocumentBundle(DAList):
         Returns:
             str: HTML representation of a table with documents and their associated actions.
         """
-        if not hasattr(self, "_cached_zip_label"):
-            self._cached_zip_label = str(self.zip_label)
+        if not view_label:
+            view_label = str(self.view_label) or word("View")
 
-        if not hasattr(self, "_cached_full_pdf_label"):
-            self._cached_full_pdf_label = str(self.full_pdf_label)
+        if not download_label:
+            download_label = str(self.download_label) or word("Download")
+
+        if not send_label:
+            send_label = str(self.send_label) or word("Send")
 
         if zip_format is None:
             zip_format = format
@@ -2123,7 +2138,7 @@ class ALDocumentBundle(DAList):
         # Add a zip file row if included
         if include_zip and bundled_zip:
             if not zip_label:
-                zip_label = self._cached_zip_label
+                zip_label = str(self.zip_label)
             filename_root = os.path.splitext(str(self.filename))[0]
             zip_button = action_button_html(
                 bundled_zip.url_for(
@@ -2142,7 +2157,7 @@ class ALDocumentBundle(DAList):
 
         if include_full_pdf and bundled_pdf:
             if not full_pdf_label:
-                full_pdf_label = self._cached_full_pdf_label
+                full_pdf_label = str(self.full_pdf_label)
             filename_root = os.path.splitext(str(self.filename))[0]
             full_pdf_button = action_button_html(
                 bundled_pdf.url_for(
@@ -2239,12 +2254,17 @@ class ALDocumentBundle(DAList):
         return html
 
     def send_email_table_row(
-        self, key: str = "final", send_label: str = "Send", send_icon: str = "envelope"
+        self,
+        key: str = "final",
+        send_label: Optional[str] = None,
+        send_icon: str = "envelope",
     ) -> str:
         """
         Generate HTML doc table row for an input box and button that allows
         someone to send the bundle to the specified email address.
 
+        This should normally only be called by download_list_html.
+
         Args:
             key (str): A key used to identify which version of the ALDocument to send. Defaults to "final".
             send_label (str): Label for the 'send' button. Default is "Send".
@@ -2253,14 +2273,12 @@ class ALDocumentBundle(DAList):
         Returns:
             str: The generated HTML string for the table row.
         """
+        if not send_label:
+            send_label = str(self.send_label) or word("Send")
+
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
-        if not hasattr(self, "_cached_get_email_copy"):
-            self._cached_get_email_copy = str(self.get_email_copy)
-        if not hasattr(self, "_cached_include_editable_documents"):
-            self._cached_include_editable_documents = str(
-                self.include_editable_documents
-            )
+
         name = html_safe_str(self.instanceName) + random_suffix()
         al_wants_editable_input_id = "_ignore_al_wants_editable_" + name
         al_email_input_id = "_ignore_al_doc_email_" + name
@@ -2298,7 +2316,7 @@ class ALDocumentBundle(DAList):
         email: str,
         editable: Optional[bool] = None,
         template_name: str = "",
-        label: str = "Send",
+        label: Optional[str] = None,
         icon: str = "envelope",
         color: str = "primary",
         key: str = "final",
@@ -2322,10 +2340,11 @@ class ALDocumentBundle(DAList):
         Returns:
             str: The generated HTML string for the button.
         """
+        if label is None:
+            label = str(self.send_label) or word("Send")
+
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
-        if not hasattr(self, "_cached_get_email_copy"):
-            self._cached_get_email_copy = str(self.get_email_copy)
         name = html_safe_str(self.instanceName) + random_suffix()
         al_send_button_id = "al_send_email_to_button_" + name
 
@@ -2392,12 +2411,6 @@ class ALDocumentBundle(DAList):
         """
         if not self.has_enabled_documents():
             return ""  # Don't let people email an empty set of documents
-        if not hasattr(self, "_cached_get_email_copy"):
-            self._cached_get_email_copy = str(self.get_email_copy)
-        if not hasattr(self, "_cached_include_editable_documents"):
-            self._cached_include_editable_documents = str(
-                self.include_editable_documents
-            )
 
         if isinstance(preferred_formats, str):
             preferred_formats = [preferred_formats]
@@ -2431,7 +2444,7 @@ class ALDocumentBundle(DAList):
         # Container of whole email section with header
         return_str = f"""
   <fieldset class="al_send_bundle al_send_section_alone {html_safe_str(self.instanceName)}" id="al_send_bundle_{name}" name="al_send_bundle_{name}">
-    <legend class="h4 al_doc_email_header">{self._cached_get_email_copy}</legend> 
+    <legend class="h4 al_doc_email_header">{str(self.get_email_copy)}</legend> 
     """
         # "Editable" checkbox
         if (
@@ -2444,7 +2457,7 @@ class ALDocumentBundle(DAList):
     <div class="form-check-container">
       <div class="form-check">
         <input class="form-check-input al_wants_editable" type="checkbox" id="{al_wants_editable_input_id}">
-        <label class="al_wants_editable form-check-label" for="{al_wants_editable_input_id}">{self._cached_include_editable_documents}
+        <label class="al_wants_editable form-check-label" for="{al_wants_editable_input_id}">{str(self.include_editable_documents)}
         </label>
       </div>
     </div>
@@ -2863,10 +2876,11 @@ class ALExhibitList(DAList):
 
     Attributes:
         maximum_size (int): The maximum allowed size in bytes of the entire document.
+        maximum_size_per_doc (int): The maximum allowed size in bytes per document in the list
         auto_label (bool): If True, automatically numbers exhibits for cover page and table of contents. Defaults to True.
         auto_labeler (Callable): An optional function or lambda to transform the exhibit's index to a label.
                                  Uses A..Z labels by default.
-        auto_ocr (bool): If True, automatically starts OCR processing for uploaded exhibits. Defaults to True.
+        auto_ocr (bool): If True, automatically starts OCR processing for uploaded exhibits. Defaults to False.
     """
 
     def init(self, *pargs, **kwargs) -> None:
@@ -3061,6 +3075,7 @@ class ALExhibitDocument(ALDocument):
     auto_ocr: bool
     bates_prefix: str
     maximum_size: int
+    maximum_size_per_doc: int
     suffix_to_append: str
     exhibits: ALExhibitList
     table_of_contents: DAFile
@@ -3085,8 +3100,13 @@ class ALExhibitDocument(ALDocument):
         else:
             self.include_exhibit_cover_pages = True
             self.exhibits.include_exhibit_cover_pages = True
+        if hasattr(self, "maximum_size_per_doc"):
+            self.exhibits.maximum_size_per_doc = self.maximum_size_per_doc
         if hasattr(self, "maximum_size"):
             self.exhibits.maximum_size = self.maximum_size
+            if not hasattr(self, "maximum_size_per_doc"):
+                self.maximum_size_per_doc = self.maximum_size
+                self.exhibits.maximum_size_per_doc = self.maximum_size
         if hasattr(self, "include_table_of_contents"):
             self.exhibits.include_table_of_contents = self.include_table_of_contents
         else: