docassemble.AssemblyLine 4.5.0__tar.gz → 4.6.0__tar.gz

docassemble_assemblyline-4.6.0/MANIFEST.in

@@ -0,0 +1,17 @@
+include README.md
+graft docassemble/AssemblyLine/data
+recursive-exclude * *.egg-info
+recursive-exclude .git *
+recursive-exclude venv *
+recursive-exclude .github *
+recursive-exclude .pytest_cache *
+recursive-exclude .vscode *
+recursive-exclude build *
+recursive-exclude dist *
+recursive-exclude * __pycache__
+recursive-exclude * *.pyc
+recursive-exclude * *.pyo
+recursive-exclude * *.orig
+recursive-exclude * *~
+recursive-exclude * *.bak
+recursive-exclude * *.swp

{docassemble_assemblyline-4.5.0/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-4.6.0}/PKG-INFO

@@ -1,9 +1,7 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.5.0
+Version: 4.6.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: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
 License-Expression: MIT
 Project-URL: Homepage, https://courtformsonline.org
@@ -11,8 +9,6 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: docassemble.ALToolbox>=0.16.0
 Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
 
 # Suffolk LIT Lab Document Assembly Line

docassemble_assemblyline-4.6.0/docassemble/AssemblyLine/__init__.py

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

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/al_document.py

@@ -945,6 +945,15 @@ class ALDocument(DADict):
           instance. These values will be used to detect and handle overflow.
         has_addendum (bool): (optional) Defaults to False. Set to True if the
           document could have overflow, like for a PDF template.
+        default_overflow_message (str): The message appended to truncated text when it overflows
+          to the addendum. Defaults to `"..."`. This is used as the fallback whenever
+          `overflow_message=None` is passed to :meth:`safe_value`,
+          :meth:`overflow_value`, or :meth:`original_or_overflow_message`.
+          Override per-document by setting `my_doc.default_overflow_message`.
+        suffix_to_append (str): When the document key matches this value, it is appended to
+          the output filename to distinguish it from other versions. Defaults to `"preview"`
+          so the preview version is saved as e.g. `myDoc_preview.pdf` while the final
+          version is saved as `myDoc.pdf`.
 
     Note:
         The `enabled` attribute should always be defined by a code block or the
@@ -1099,6 +1108,7 @@ class ALDocument(DADict):
 
         if isinstance(main_doc, DAFileCollection):
             main_doc = main_doc.pdf
+        if isinstance(main_doc, DAFile):
             main_doc.title = self.title
             main_doc.filename = filename
             try:
@@ -1254,6 +1264,8 @@ class ALDocument(DADict):
         Args:
             field_name (str): The name of the field to check.
             overflow_message (str): A short message to go on the page where text is cutoff.
+                If `None`, falls back to `self.default_overflow_message`
+                (`"..."` by default).
             input_width (int): The width, in characters, of the input box. Defaults to 80.
             preserve_newlines (bool): Determines whether newlines are preserved in the "safe" text.
                 Defaults to False, which means all newlines are removed. This allows more text to appear
@@ -1292,7 +1304,9 @@ class ALDocument(DADict):
 
         Args:
             field_name (str): The name of the field to retrieve the safe value from.
-            overflow_message (Optional[str]): Message to display when the field value overflows. Defaults to the class's default overflow message.
+            overflow_message (Optional[str]): Message appended when the field value is truncated.
+                If `None`, falls back to `self.default_overflow_message`
+                (`"..."` by default).
             preserve_newlines (bool): Whether to maintain newlines in the output. Defaults to False.
             input_width (int): The expected input width, used for formatting. Defaults to 80.
             preserve_words (bool): Whether to avoid splitting words during formatting. Defaults to True.
@@ -1322,7 +1336,9 @@ class ALDocument(DADict):
 
         Args:
             field_name (str): The name of the field to retrieve the overflow value from.
-            overflow_message (Optional[str]): Message to display when the field value overflows. Defaults to the object's default overflow message.
+            overflow_message (Optional[str]): Message appended when the safe portion of the field
+                value is truncated. If `None`, falls back to `self.default_overflow_message`
+                (`"..."` by default).
             preserve_newlines (bool): Whether to maintain newlines in the output. Defaults to False.
             input_width (int): The expected input width, used for formatting. Defaults to 80.
             preserve_words (bool): Whether to avoid splitting words during formatting. Defaults to True.
@@ -1548,7 +1564,62 @@ class ALDocumentBundle(DAList):
         enabled (bool, optional): Determines if the bundle is active. Defaults to True.
         auto_gather (bool, optional): Automatically gathers attributes. Defaults to False.
         gathered (bool, optional): Specifies if attributes have been gathered. Defaults to True.
-        default_parity (Optional[Literal["even", "odd"]]): Default parity to enforce on the PDF. Defaults to None.
+        default_parity (Optional[Literal["even", "odd"]]): Default parity to enforce on the PDF.
+            When set, :meth:`as_pdf` will append a blank page if necessary to reach the desired
+            parity. Defaults to `None` (no enforcement).
+        suffix_to_append (str): When the document key matches this value, it is appended to the
+            output filename to distinguish it from other versions. Defaults to `"preview"`
+            so the preview bundle is saved as e.g. `bundle_preview.pdf` while the final is
+            saved as `bundle.pdf`.
+        view_label (DALazyTemplate): Template providing the label for "View" buttons in
+            :meth:`download_list_html`. Defined generically in `ql_baseline.yml`; resolves to
+            `"View"` (or its translation). Override by assigning a new template to
+            `your_bundle.view_label` in your interview YAML.
+        download_label (DALazyTemplate): Template providing the label for "Download" buttons in
+            :meth:`download_list_html`. Defined generically in `ql_baseline.yml`; resolves to
+            `"Download"` (or its translation).
+        send_label (DALazyTemplate): Template providing the label for "Send" buttons in
+            :meth:`download_list_html`, :meth:`send_email_table_row`, and
+            :meth:`send_button_to_html`. Defined generically in `ql_baseline.yml`; resolves to
+            `"Send"` (or its translation).
+        zip_label (DALazyTemplate): Template providing the label for the "Download all" zip
+            button in :meth:`download_list_html`. Defined generically in `al_document.yml`;
+            resolves to `"Download all"` (or its translation).
+        full_pdf_label (DALazyTemplate): Template providing the label for the "Download as one
+            PDF" button in :meth:`download_list_html`. Defined generically in
+            `al_document.yml`; resolves to `"Download as one PDF"` (or its translation).
+        send_email_template (DALazyTemplate): Template used as the default email subject and
+            body in :meth:`send_email` when `template=None`. Defined generically in
+            `al_document.yml`. The subject defaults to
+            `"Your <document> document from <app> is ready"` and the body to
+            `"Your document is attached. Visit <homepage> to learn more."`
+            Override by assigning a new template block to `your_bundle.send_email_template`
+            in your interview YAML.
+        get_email_copy (DALazyTemplate): Template providing the header text for the email input
+            section rendered by :meth:`send_button_html`. Defined generically in
+            `al_document.yml`; resolves to `"Get a copy of the documents in email"`
+            (or its translation).
+        include_editable_documents (DALazyTemplate): Template providing the label for the
+            "include editable copy" checkbox in :meth:`send_button_html`. Defined generically
+            in `al_document.yml`; resolves to `"Include an editable copy"`
+            (or its translation).
+        add_page_numbers (bool): If `True`, Bates-style page numbers are stamped onto the
+            merged PDF produced by :meth:`as_pdf`. Defaults to `False`.
+        page_number_prefix (str): Text prepended to each stamped page number (e.g. `"EX-"`).
+            Defaults to `""`.
+        page_number_start (int): The first page number used when stamping page numbers.
+            Defaults to `1`.
+        page_number_digits (int): Minimum number of digits in each stamped page number;
+            shorter numbers are left-padded with zeros. Defaults to `5`.
+        page_number_area (Optional[str]): Location on the page where numbers are stamped.
+            Accepted values: `"TOP_LEFT"`, `"TOP_RIGHT"`, `"BOTTOM_LEFT"`,
+            `"BOTTOM_RIGHT"`. Defaults to `None` (bottom-right).
+        page_number_font_size (float): Font size in points for stamped page numbers.
+            Defaults to `10`.
+        page_number_offset_horizontal (float): Horizontal inset in pixels from the nearest
+            page edge for stamped page numbers. Defaults to `15`.
+        page_number_offset_vertical (float): Vertical inset in pixels from the nearest page
+            edge for stamped page numbers. Defaults to `15`.
 
     Examples:
         Given three documents: `Cover page`, `Main motion form`, and `Notice of Interpreter Request`,
@@ -1660,7 +1731,14 @@ class ALDocumentBundle(DAList):
                 pdfa=pdfa,
                 append_matching_suffix=append_matching_suffix,
             )
+            bundle_filename = f"{base_name(self.filename)}{append_suffix}.pdf"
             pdf.title = self.title
+            pdf.filename = bundle_filename
+            try:
+                pdf.set_attributes(filename=bundle_filename)
+                pdf.set_mimetype("application/pdf")
+            except:
+                pass
         else:
             pdf = pdf_concatenate(
                 [document.as_pdf(key=key, refresh=refresh) for document in files],
@@ -1677,6 +1755,7 @@ class ALDocumentBundle(DAList):
                 font_size=self.page_number_font_size,
                 offset_horizontal=self.page_number_offset_horizontal,
                 offset_vertical=self.page_number_offset_vertical,
+                filename=pdf.filename,
             )
         pdf.title = self.title
         setattr(self.cache, safe_key, pdf)
@@ -2064,13 +2143,21 @@ 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 self.view_label or "View".
+            view_label (str): Label for the 'view' button. If `None`, falls back to
+                `self.view_label` (a translatable template defined in `ql_baseline.yml`,
+                defaulting to `"View"`).
             view_icon (str): Icon for the 'view' button, default is "eye".
-            download_label (str): Label for the 'download' button, default is self.download_label or "Download".
+            download_label (str): Label for the 'download' button. If `None`, falls back to
+                `self.download_label` (a translatable template defined in `ql_baseline.yml`,
+                defaulting to `"Download"`).
             download_icon (str): Icon for the 'download' button, default is "download".
-            send_label (str): Label for the 'send' button. Default is self.send_label or "Send".
+            send_label (str): Label for the 'send' button. If `None`, falls back to
+                `self.send_label` (a translatable template defined in `ql_baseline.yml`,
+                defaulting to `"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_label (Optional[str]): Label for the zip button. If `None`, falls back to
+                `self.zip_label` (a translatable template defined in `al_document.yml`,
+                defaulting to `"Download all"`).
             zip_icon (str): Icon for the zip option, default is "file-archive".
             zip_row_label (str, optional): Text to go in the left-most column
                 of the table's zip row. Will default to the value of `self.title`.
@@ -2137,7 +2224,7 @@ class ALDocumentBundle(DAList):
                 download_doc.url_for(
                     attachment=True, display_filename=download_filename
                 ),
-                label=download_label,
+                label=f'{download_label} <span class="visually-hidden">{title}</span>',
                 icon=download_icon,
                 color="primary",
                 size="md",
@@ -2152,7 +2239,7 @@ class ALDocumentBundle(DAList):
                     result["pdf"].url_for(
                         attachment=False, display_filename=view_filename
                     ),
-                    label=view_label,
+                    label=f'{view_label} <span class="visually-hidden">{title}</span>',
                     icon=view_icon,
                     color="secondary",
                     size="md",
@@ -2296,7 +2383,9 @@ class ALDocumentBundle(DAList):
 
         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".
+            send_label (str): Label for the 'send' button. If `None`, falls back to
+                `self.send_label` (a translatable template defined in `ql_baseline.yml`,
+                defaulting to `"Send"`).
             send_icon (str): Icon for the 'send' button. Default is "envelope".
 
         Returns:
@@ -2360,7 +2449,9 @@ class ALDocumentBundle(DAList):
             email (str): The recipient's email address.
             editable (bool, optional): Flag indicating if the bundle is editable. Defaults to False. (deprecated; use preferred_formats instead)
             template_name (str, optional): The name of the template to be used. Defaults to an empty string.
-            label (str, optional): The label for the button. Defaults to "Send".
+            label (str, optional): The label for the button. If `None`, falls back to
+                `self.send_label` (a translatable template defined in `ql_baseline.yml`,
+                defaulting to `"Send"`).
             icon (str, optional): The Fontawesome icon for the button. Defaults to "envelope".
             color (str, optional): The Bootstrap color of the button. Defaults to "primary".
             key (str, optional): A key used to identify which version of the ALDocument to send. Defaults to "final".
@@ -2412,7 +2503,7 @@ class ALDocumentBundle(DAList):
         key: str = "final",
         show_editable_checkbox: bool = True,
         template_name: str = "",
-        label: str = "Send",
+        label: Optional[str] = None,
         icon: str = "envelope",
         preferred_formats: Optional[Union[str, List[str]]] = None,
         email_legend_class: str = "h4",
@@ -2441,6 +2532,9 @@ class ALDocumentBundle(DAList):
         Returns:
             str: The generated HTML string for the input box and 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
 
@@ -2528,7 +2622,14 @@ class ALDocumentBundle(DAList):
             to (Any): The email address, list of email addresses, or list of Individuals with a .email attribute to send to.
             key (str, optional): Specifies which version of the document to send. Defaults to "final".
             editable (bool, optional): If True, sends the editable documents. Defaults to False. (Deprecated)
-            template (Any): The template variable for the subject and body of the email, similar to da `send_email` `template` variable.
+            template (Any, optional): The template variable for the subject and body of the email,
+                similar to the `template` parameter of docassemble's `send_email` function.
+                If `None`, falls back to `self.send_email_template`, a template defined
+                generically in `al_document.yml`. Its subject defaults to
+                `"Your <document> document from <app> is ready"` and its body to
+                `"Your document is attached. Visit <homepage> to learn more."`
+                Override it by assigning a new template block to `your_bundle.send_email_template`
+                in your interview YAML.
             preferred_formats (str): Specifies the format of the files to send. Can be "pdf" or "docx", or a list of these formats. Overrides deprecated `editable` keyword.
             **kwargs: Additional parameters to pass to the da `send_email` function.
 

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/al_code.yml

@@ -155,15 +155,16 @@ code: |
     for signature in signature_fields:
       # Signature fields are strings like "users[0].signature". If the string ends in .signature, remove that and replace with .typed_signature, only at the end of the string
       if signature.endswith("signature"):
-        typed_signature = signature[:-9] + "typed_signature"
-        define(signature, DAFile(signature, filename="signature.png"))
+        typed_signature = value(signature[:-9] + "typed_signature")
+        define(signature, DAFile(signature, filename="signature.png", alt_text=typed_signature))
         value(signature).initialize()
         create_signature(
-          value(typed_signature),
+          typed_signature,
           value(signature).path(),
           signature_prefix=al_typed_signature_prefix,
           font_name=al_typed_signature_font,
         )
+        del(typed_signature)
       else:
         log(
           "Signature field "

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/al_document.yml

@@ -89,7 +89,7 @@ code: |
   # Used in the email subject line when email is triggered on download screen.
   # This defaults to the interview title. For example, if the
   # interview title is "Guardianship Helper", the email
-  # subject would be "Your Guardianship Helper document from CourtFormsOnline is ready".
+  # subject would be "Your Guardianship Helper document from docassemble is ready".
   # Customize this if you prefer something like "Your guardianship document is ready"
   x.document_label = str(
     all_variables(special="titles").get(
@@ -123,12 +123,12 @@ content: |
 generic object: ALDocumentBundle
 template: x.zip_label
 content: |
-  Download all
+  Download all <span class="visually-hidden">${ x.title }</span> documents
 ---
 generic object: ALDocumentBundle
 template: x.full_pdf_label
 content: |
-  Download as one PDF
+  Download <span class="visually-hidden">${ x.title }</span> as one PDF
 ---
 id: al exhibit ocr pages bg
 event: al_exhibit_ocr_pages

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/al_language.yml

@@ -19,13 +19,16 @@ code: |
 default screen parts:
   navigation bar html: |
     % if enable_al_language and len(al_interview_languages) > 1:
-    ${ get_language_list_dropdown(al_interview_languages,current=al_user_language ) }
+    ${ get_language_list_dropdown(al_interview_languages, current=session_local.attr("al_user_language") or al_user_language ) }
     % endif
 ---
 initial: True
 code: |
   if enable_al_language:
-    set_language(al_user_language)
+    if session_local.attr("al_user_language"):
+      set_language(session_local.attr("al_user_language"))
+    else:
+      set_language(al_user_language)
   process_action()
 ---
 code: |
@@ -37,6 +40,14 @@ code: |
 ---
 event: al_change_language
 code: |
+  # Set browser-specific language for this interview session
+  if "lang" in action_arguments():
+    session_local.al_user_language = action_argument("lang")
+    set_language(session_local.al_user_language)
+---
+event: al_get_language_list_change_language
+code: |
+  # Set "global" language for this interview session instead of user-specific
   if "lang" in action_arguments():
     al_user_language = action_argument("lang")
     set_language(al_user_language)

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/al_settings.yml

@@ -7,13 +7,13 @@ code: |
   # Set this to the name of your application
   # Defaults to checking for a possible name from global docassemble config
   al_app_name = get_config(
-    "appname", get_config("external hostname", "CourtFormsOnline.org")
+    "appname", get_config("external hostname", "docassemble")
   )
 ---
 code: |
   # The name of your organization. Defaults to a similar value as `al_app_name`,
   # but is still distinct
-  AL_ORGANIZATION_TITLE = get_config("appname", "CourtFormsOnline")
+  AL_ORGANIZATION_TITLE = get_config("appname", "docassemble")
 ---
 code: |
   AL_ORGANIZATION_HOMEPAGE = get_config("app homepage", "https://courtformsonline.org")

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/interview_list.yml

@@ -158,7 +158,7 @@ default screen parts:
     % elif showifdef("AL_ORGANIZATION_TITLE"):
     ${ AL_ORGANIZATION_TITLE }
     % else:
-    ${ get_config("app name", "CourtFormsOnline") }
+    ${ get_config("appname", "docassemble") }
     % endif
   short title: |
     % if PAGE_TITLE:
@@ -166,7 +166,7 @@ default screen parts:
     % elif showifdef("AL_ORGANIZATION_TITLE"):
     ${ AL_ORGANIZATION_TITLE }
     % else:
-    ${ get_config("app name", "CourtFormsOnline") }
+    ${ get_config("appname", "docassemble") }
     % endif
   title url: |
     % if LOGO_URL:
@@ -197,7 +197,7 @@ default screen parts:
     % elif showifdef("AL_ORGANIZATION_TITLE"):
         <span class="title-row-1">${ AL_ORGANIZATION_TITLE }</span>    
     % else:
-        <span class="title-row-1">${ get_config("app name", "CourtFormsOnline") }</span>    
+        <span class="title-row-1">${ get_config("appname", "docassemble") }</span>    
     % endif
     % if LOGO_TITLE_ROW_2:
         <span class="title-row-2">${ LOGO_TITLE_ROW_2 }</span>
@@ -223,7 +223,7 @@ default screen parts:
     % elif showifdef("AL_ORGANIZATION_TITLE"):
         <span class="title-row-1">${ AL_ORGANIZATION_TITLE }</span>    
     % else:
-        <span class="title-row-1">${ get_config("app name", "CourtFormsOnline") }</span>    
+        <span class="title-row-1">${ get_config("appname", "docassemble") }</span>    
     % endif
     % if LOGO_TITLE_ROW_2:
         <span class="title-row-2">${ LOGO_TITLE_ROW_2 }</span>

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/ql_baseline.yml

@@ -1248,6 +1248,8 @@ question: |
 signature: x.signature
 under: |
   ${x}
+validation code: |
+  x.signature.alt_text = f"Signature of {x.name_full()}"
 ---
 id: signature date
 question: |
@@ -2666,8 +2668,10 @@ content: "Download"
 ---
 generic object: ALDocumentBundle
 template: x.send_label
-content: "Send"
+content: |
+  Send <span class="visually-hidden">${ x.title } documents</span>
 ---
 generic object: ALDocumentBundle
 template: x.send_button_to_label
-content: "Send"
+content: |
+  Send <span class="visually-hidden">${ x.title } documents</span>

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/data/questions/test_signature.yml

@@ -23,6 +23,8 @@ subquestion: |
   ${ users[0].signature }
   
   % endif
+attachment:
+  docx template file: sample_word_template.docx
 ---
 code: |
   al_form_requires_digital_signature = False

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/language.py

@@ -173,7 +173,7 @@ def get_language_list(
     current="",
     lang_codes: Optional[List[str]] = None,
     languages_path: Optional[str] = None,
-    event_name="al_change_language",
+    event_name="al_get_language_list_change_language",
 ) -> str:
     """
     Given a list of language codes, returns

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/sessions.py

@@ -310,8 +310,8 @@ def get_interview_metadata(
             {"filename": filename, "tags": metadata_key_name, "session_id": session_id},
         ).fetchone()
 
-    if row:
-        return row[0]  # row is a RowMapping/tuple; data is column 0
+        if row:
+            return row[0]  # row is a RowMapping/tuple; data is column 0
     return {}
 
 
@@ -447,6 +447,7 @@ def get_saved_interview_list(
             log("Asked to get interview list for user that is not logged in")
             return []
 
+    sessions = []
     with db.connect() as con:
         rs = con.execute(
             get_sessions_query,
@@ -463,9 +464,8 @@ def get_saved_interview_list(
                 ),  # We need to pass a value to the query, but it's treated as a flag
             },
         )
-    sessions = []
-    for session in rs:
-        sessions.append(dict(session._mapping))
+        for session in rs:
+            sessions.append(dict(session._mapping))
 
     return sessions
 
@@ -665,12 +665,12 @@ def find_matching_sessions(
         for column, val_tuple in metadata_filters.items():
             parameters[f"{column}_filter"] = val_tuple[0]
 
+    sessions = []
     with db.connect() as con:
         rs = con.execute(get_sessions_query, parameters)
 
-    sessions = []
-    for session in rs:
-        sessions.append(dict(session._mapping))
+        for session in rs:
+            sessions.append(dict(session._mapping))
 
     return sessions
 

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble/AssemblyLine/test_al_document.py

@@ -35,6 +35,75 @@ class test_dont_assume_pdf(unittest.TestCase):
         pass
 
 
+class FakePdf(DAFile):
+    def __init__(self, filename="file.pdf", title="child"):
+        self.instanceName = "fake_pdf"
+        self.has_nonrandom_instance_name = True
+        self.filename = filename
+        self.title = title
+        self.attribute_filenames = []
+        self.mimetype = None
+
+    def set_attributes(self, **kwargs):
+        if "filename" in kwargs:
+            self.attribute_filenames.append(kwargs["filename"])
+
+    def set_mimetype(self, mimetype):
+        self.mimetype = mimetype
+
+
+class FakeSingleDoc:
+    def __init__(self, pdf):
+        self._pdf = pdf
+
+    def is_enabled(self, refresh=True):
+        return True
+
+    def as_pdf(self, **kwargs):
+        return self._pdf
+
+
+class TestSingleDocumentBundleFilename(unittest.TestCase):
+    def test_bundle_as_pdf_renames_single_document_to_bundle_filename(self):
+        child_pdf = FakePdf()
+        bundle = ALDocumentBundle(
+            "bundle",
+            elements=[FakeSingleDoc(child_pdf)],
+            title="Bundle title",
+            filename="bundle-output.pdf",
+            enabled=True,
+        )
+
+        result = bundle.as_pdf()
+
+        self.assertIs(result, child_pdf)
+        self.assertEqual(result.title, "Bundle title")
+        self.assertEqual(result.filename, "bundle-output.pdf")
+        self.assertEqual(result.attribute_filenames, ["bundle-output.pdf"])
+        self.assertEqual(result.mimetype, "application/pdf")
+
+
+class TestSingleDocumentFilename(unittest.TestCase):
+    def test_document_as_pdf_renames_plain_dafile_to_document_filename(self):
+        child_pdf = FakePdf()
+        doc = ALDocument(
+            "doc",
+            title="Document title",
+            filename="document-output.pdf",
+            enabled=True,
+            has_addendum=False,
+        )
+        doc["final"] = child_pdf
+
+        result = doc.as_pdf(refresh=False)
+
+        self.assertIs(result, child_pdf)
+        self.assertEqual(result.title, "Document title")
+        self.assertEqual(result.filename, "document-output.pdf")
+        self.assertEqual(result.attribute_filenames, ["document-output.pdf"])
+        self.assertEqual(result.mimetype, "application/pdf")
+
+
 class test_aladdendum(unittest.TestCase):
     def test_safe_value(self):
         text_testcase1 = """Charged by my father with a very delicate mission, I repaired, towards the end of May, 1788, to the château of Ionis, situated a dozen leagues distant, in the lands lying between Angers and Saumur. I was twenty-two, and already practising the profession of lawyer, for which I experienced but slight inclination, although neither the study of business nor of argument had presented serious difficulties to me. Taking my youth into consideration, I was not esteemed without talent, and the standing of my father, a lawyer renowned in the locality, assured me a brilliant patronage in the future, in return for any paltry efforts I might make to be worthy of replacing him. But I would have preferred literature, a more dreamy life, a more independent and more individual use of my faculties, a responsibility less submissive to the passions and interests of others. As my family was well off, and I an only son, greatly spoiled and petted, I might have chosen my own career, but I would have thus afflicted my father, who took pride in his ability to direct me 4in the road which he had cleared in advance, and I loved him too tenderly to permit my instinct to outweigh his wishes.

docassemble_assemblyline-4.6.0/docassemble/AssemblyLine/test_all_imports.py

@@ -0,0 +1,12 @@
+# Makes sure that loading each module file works.
+# Includes all imports not covered by other test files.
+
+from .al_courts import *
+from .custom_jinja_filters import *
+from .language import *
+from .sign import *
+
+try:
+    from .sessions import *
+except SystemExit as ex:
+    print(f"Ignoring SystemExit error (expected from config.py: {ex})")

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0/docassemble.AssemblyLine.egg-info}/PKG-INFO

@@ -1,9 +1,7 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.5.0
+Version: 4.6.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: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
 License-Expression: MIT
 Project-URL: Homepage, https://courtformsonline.org
@@ -11,8 +9,6 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: docassemble.ALToolbox>=0.16.0
 Requires-Dist: docassemble.GitHubFeedbackForm>=0.4.1.1
-Dynamic: author
-Dynamic: home-page
 Dynamic: license-file
 
 # Suffolk LIT Lab Document Assembly Line

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/docassemble.AssemblyLine.egg-info/SOURCES.txt

@@ -2,12 +2,9 @@ LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
-setup.cfg
-setup.py
 docassemble.AssemblyLine.egg-info/PKG-INFO
 docassemble.AssemblyLine.egg-info/SOURCES.txt
 docassemble.AssemblyLine.egg-info/dependency_links.txt
-docassemble.AssemblyLine.egg-info/not-zip-safe
 docassemble.AssemblyLine.egg-info/requires.txt
 docassemble.AssemblyLine.egg-info/top_level.txt
 docassemble/AssemblyLine/__init__.py
@@ -17,11 +14,11 @@ docassemble/AssemblyLine/al_general.py
 docassemble/AssemblyLine/custom_jinja_filters.py
 docassemble/AssemblyLine/language.py
 docassemble/AssemblyLine/py.typed
-docassemble/AssemblyLine/requirements.txt
 docassemble/AssemblyLine/sessions.py
 docassemble/AssemblyLine/sign.py
 docassemble/AssemblyLine/test_al_document.py
 docassemble/AssemblyLine/test_al_general.py
+docassemble/AssemblyLine/test_all_imports.py
 docassemble/AssemblyLine/test_language.py
 docassemble/AssemblyLine/data/questions/al_code.yml
 docassemble/AssemblyLine/data/questions/al_document.yml

{docassemble_assemblyline-4.5.0 → docassemble_assemblyline-4.6.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "docassemble.AssemblyLine"
-version = "4.5.0"
+version = "4.6.0"
 description = "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."
 readme = "README.md"
 authors = [
@@ -62,3 +62,17 @@ ignore_missing_imports = true
 [[tool.mypy.overrides]]
 module = "backports.*"
 ignore_missing_imports = true
+
+[dependency-groups]
+dev = [
+    "docassemble.base>=1.7",
+    "docassemble.webapp>=1.7",
+    "pytest>=7.0",
+    "mypy",
+    "pandas-stubs",
+    "sqlalchemy[mypy]>=1.3.0",
+    "types-PyYAML",
+    "types-requests",
+    "types-psycopg2",
+]
+

docassemble_assemblyline-4.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

docassemble_assemblyline-4.5.0/MANIFEST.in

@@ -1 +0,0 @@
-include README.md

docassemble_assemblyline-4.5.0/docassemble/AssemblyLine/__init__.py

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

docassemble_assemblyline-4.5.0/docassemble/AssemblyLine/requirements.txt

@@ -1,9 +0,0 @@
-docassemble.base>=1.3
-docassemble.webapp
-mypy
-pandas-stubs
-sqlalchemy[mypy]
-types-PyYAML
-PyGithub
-types-requests
-types-psycopg2

docassemble_assemblyline-4.5.0/docassemble.AssemblyLine.egg-info/not-zip-safe

@@ -1 +0,0 @@
-

docassemble_assemblyline-4.5.0/setup.cfg

@@ -1,7 +0,0 @@
-[metadata]
-description_file = README.md
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

docassemble_assemblyline-4.5.0/setup.py

@@ -1,60 +0,0 @@
-import os
-import sys
-from setuptools import setup, find_namespace_packages
-from fnmatch import fnmatchcase
-from distutils.util import convert_path
-
-standard_exclude = ('*.pyc', '*~', '.*', '*.bak', '*.swp*')
-standard_exclude_directories = ('.*', 'CVS', '_darcs', './build', './dist', 'EGG-INFO', '*.egg-info')
-
-def find_package_data(where='.', package='', exclude=standard_exclude, exclude_directories=standard_exclude_directories):
-    out = {}
-    stack = [(convert_path(where), '', package)]
-    while stack:
-        where, prefix, package = stack.pop(0)
-        for name in os.listdir(where):
-            fn = os.path.join(where, name)
-            if os.path.isdir(fn):
-                bad_name = False
-                for pattern in exclude_directories:
-                    if (fnmatchcase(name, pattern)
-                        or fn.lower() == pattern.lower()):
-                        bad_name = True
-                        break
-                if bad_name:
-                    continue
-                if os.path.isfile(os.path.join(fn, '__init__.py')):
-                    if not package:
-                        new_package = name
-                    else:
-                        new_package = package + '.' + name
-                        stack.append((fn, '', new_package))
-                else:
-                    stack.append((fn, prefix + name + '/', package))
-            else:
-                bad_name = False
-                for pattern in exclude:
-                    if (fnmatchcase(name, pattern)
-                        or fn.lower() == pattern.lower()):
-                        bad_name = True
-                        break
-                if bad_name:
-                    continue
-                out.setdefault(package, []).append(prefix+name)
-    return out
-
-setup(name='docassemble.AssemblyLine',
-      version='4.5.0',
-      description=(''),
-      long_description='# Suffolk LIT Lab Document Assembly Line\r\n\r\n[![PyPI version](https://badge.fury.io/py/docassemble-AssemblyLine.svg)](https://badge.fury.io/py/docassemble-AssemblyLine)\r\n\r\n<img src="https://user-images.githubusercontent.com/7645641/142245862-c2eb02ab-3090-4e97-9653-bb700bf4c54d.png" alt="drawing" width="300" alt="work together" style="align: center;"/>\r\n\r\nThe Assembly Line Project is a collection of volunteers, students, and institutions who joined together\r\nduring the COVID-19 pandemic to help increase access to the court system. Our vision is mobile-friendly,\r\neasy to use **guided** online forms that help empower litigants to access the court remotely.\r\n\r\nOur signature project is [CourtFormsOnline.org](https://courtformsonline.org).\r\n\r\nWe designed a step-by-step, assembly line style process for automating court forms on top of Docassemble\r\nand built several tools along the way that **you** can use in your home jurisdiction.\r\n\r\nThis package contains **runtime code** and **pre-written questions** to support authoring robust, \r\nconsistent, and attractive Docassemble interviews that help complete court forms.\r\n\r\nRead more on our [documentation page](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/).\r\n\r\n\r\n# Related repositories\r\n\r\n* https://github.com/SuffolkLitLab/docassemble-ALWeaver\r\n* https://github.com/SuffolkLitLab/docassemble-ALMassachusetts\r\n* https://github.com/SuffolkLitLab/docassemble-MassAccess\r\n* https://github.com/SuffolkLitLab/docassemble-ALThemeTemplate\r\n* https://github.com/SuffolkLitLab/EfileProxyServer\r\n\r\n# Documentation\r\n\r\nhttps://suffolklitlab.org/docassemble-AssemblyLine-documentation/\r\n\r\n# Installation\r\n\r\n## Menu-driven installation\r\n\r\nThe recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).\r\n\r\n## Manual installation\r\n\r\nNormally you do not need to manually install the Assembly Line. Use the [installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation)\r\nif you can. The instructions below are for your optional reference.\r\n\r\nThis package depends on the following configuration changes on your Docassemble server:\r\n\r\n* Ensure that [font-awesome](https://docassemble.org/docs/config.html#default%20icons) is enabled (this may be on by default:\r\n```yaml\r\ndefault icons: font awesome\r\n```\r\n* Add a [Google API key](https://docassemble.org/docs/config.html#google) that has access to:\r\n    * Google Places API\r\n    * Google Geocoding API\r\n* Add a [VoiceRSS API key](https://docassemble.org/docs/config.html#voicerss)\r\n* Add a [Twilio API key](https://docassemble.org/docs/config.html#twilio) for SMS support\r\n* Add an email account: [Mailgun](https://docassemble.org/docs/config.html#mailgun%20api) or [SendGrid](https://docassemble.org/docs/config.html#sendgrid%20api) recommended for email support\r\n* To show package update time and to enable the feedback form, add a GitHub Private Access token to your config.yml file, like this:\r\n```yaml\r\n# Needs access to create new issues on repositories\r\ngithub issues:\r\n  username: "suffolklitlab-issues"\r\n  token: "12345"\r\n# Does not need any special access to public repositories  \r\ngithub readonly:\r\n  username: "suffolklitlab-issues"\r\n  password: "45678"\r\n  type: "basic"\r\n```\r\n* If you are also using the [Assembly Line Weaver](https://github.com/SuffolkLITLab/docassemble-assemblylinewizard), you may want to set up a [Docassemble API key](https://docassemble.org/docs/api.html#manage_api) in your config.yml file to allow you to install packages automatically, like this:\r\n```yaml\r\ninstall packages api key: 12345\r\n```\r\n\r\n# Migration\r\n\r\nSee [discussion here](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/issues/69)\r\n\r\n\r\n# ALDocument class\r\n\r\n## Purpose\r\n\r\nThe ALDocument class is a small utility library that makes it simpler to use the following features in an interview:\r\n\r\n* Conditional assembly of multiple, optional documents that are triggered in different ways in your interview\r\n* An addendum for PDF files that makes it simple to deal with overflow text\r\n* A customizable download screen that lists the documents in a neat table\r\n* A customizable "send" button that allows the user to email the final forms to a location of their choice\r\n\r\nHere is a small snippet that you can copy and modify that shows how to use the most important features of the ALDocument class.\r\n\r\n```\r\n---\r\nobjects:\r\n  - CRA_Motion_to_Dismiss_attachment: ALDocument.using(filename="CRA_Motion_to_Dismiss", title="Motion to Dismiss CRA", enabled=True, has_addendum=True, default_overflow_message="[See addendum]")  \r\n---\r\nobjects:\r\n  - al_user_bundle: ALDocumentBundle.using(elements=[CRA_Motion_to_Dismiss_attachment], title="Forms to download and deliver to court", filename="motion_to_dismiss_CRA.pdf")\r\n  - al_court_bundle: ALDocumentBundle.using(elements=[CRA_Motion_to_Dismiss_attachment], title="Forms to download and deliver to court", filename="motion_to_dismiss_CRA.pdf")\r\n---\r\ngeneric object: ALDocument\r\nattachment:\r\n  variable name: x.addendum\r\n  docx template file: docx_addendum.docx\r\n---\r\ncode: |\r\n  CRA_Motion_to_Dismiss_attachment.overflow_fields[\'reasons_for_request\'].overflow_trigger = 640\r\n  CRA_Motion_to_Dismiss_attachment.overflow_fields[\'reasons_for_request\'].label = "Reasons for request"\r\n  CRA_Motion_to_Dismiss_attachment.overflow_fields.gathered = True\r\n  \r\n---\r\nattachment:\r\n    variable name: CRA_Motion_to_Dismiss_attachment[i]\r\n    name: CRA Motion to Dismiss\r\n    filename: CRA_Motion_to_Dismiss\r\n    skip undefined: True\r\n    pdf template file: CRA_Motion_to_Dismiss.pdf\r\n    fields: \r\n      - "court_county": ${ trial_court.address.county }\r\n      - "docket_number": ${ docket_number }\r\n      - "user_signature": ${ users[0].signature_if_final(i) }\r\n      - "signature_date": ${ signature_date }\r\n```\r\n\r\nIt is very common to have a *contingent* document in ALDocument. If your document is contingent, remove the `enabled=True` from the object declaration, and use\r\nsome other method to "turn on" the attachment.\r\n\r\nE.g.,\r\n\r\n```\r\ncode: |\r\n  CRA_Motion_to_Dismiss_attachment.enabled = condition1 and condition2\r\n```\r\n\r\n# Changelog\r\n\r\nSee [CHANGELOG.MD](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)\r\n',
-      long_description_content_type='text/markdown',
-      author='Suffolk Legal Innovation and Technology Lab',
-      author_email='qsteenhuis@suffolk.edu',
-      license='The MIT License (MIT)',
-      url='https://courtformsonline.org',
-      packages=find_namespace_packages(),
-      install_requires=['docassemble.ALToolbox>=0.16.0', 'docassemble.GithubFeedbackForm>=0.4.1.1'],
-      zip_safe=False,
-      package_data=find_package_data(where='docassemble/AssemblyLine/', package='docassemble.AssemblyLine'),
-     )
-