docassemble.AssemblyLine 2.27.2__tar.gz → 2.28.0__tar.gz

{docassemble.AssemblyLine-2.27.2/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-2.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docassemble.AssemblyLine
-Version: 2.27.2
+Version: 2.28.0
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
 Author-email: qsteenhuis@suffolk.edu

docassemble_assemblyline-2.28.0/docassemble/AssemblyLine/__init__.py

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

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble/AssemblyLine/al_courts.py

@@ -110,7 +110,9 @@ class ALCourt(Court):
             all_info = f"{ all_info }[BR]{ self.address.on_one_line() }"
         return f"{ all_info }[BR]{ self.description }"
 
-    def from_row(self, df_row: pd.Series, ensure_lat_long: bool = True) -> None:
+    def from_row(
+        self, df_row: Union[pd.Series, pd.DataFrame], ensure_lat_long: bool = True
+    ) -> None:
         """
         Loads data from a single Pandas Dataframe into the current court object.
         Note: It will try to convert column names that don't make valid

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble/AssemblyLine/al_document.py

@@ -1,7 +1,7 @@
 import re
 import os
 import mimetypes
-from typing import Any, Dict, List, Union, Callable, Optional
+from typing import Any, Dict, List, Literal, Union, Callable, Optional
 from docassemble.base.util import (
     Address,
     LatitudeLongitude,
@@ -34,6 +34,7 @@ from textwrap import wrap
 from math import floor
 import subprocess
 from collections import ChainMap
+import pikepdf
 
 __all__ = [
     "ALAddendumField",
@@ -180,6 +181,50 @@ def table_row(title: str, button_htmls: List[str] = []) -> str:
     return html
 
 
+def pdf_page_parity(pdf_path: str) -> Literal["even", "odd"]:
+    """
+    Count the number of pages in the PDF and
+    return "even" if it is divisible by 2 and "odd"
+    if it is not divisible by 2.
+
+    Args:
+        pdf_path (str): Path to the PDF in the filesystem
+
+    Returns:
+        Literal["even", "odd"]: The parity of the number of pages in the PDF
+    """
+    with pikepdf.open(pdf_path) as pdf:
+        num_pages = len(pdf.pages)
+        if num_pages % 2 == 0:
+            return "even"
+        return "odd"
+
+
+def add_blank_page(pdf_path: str) -> None:
+    """
+    Add a blank page to the end of a PDF.
+
+    Args:
+        pdf_path (str): Path to the PDF in the filesystem
+    """
+    # Load the PDF
+    with pikepdf.open(pdf_path, allow_overwriting_input=True) as pdf:
+        # Retrieve the last page
+        last_page = pdf.pages[-1]
+
+        # Extract the size of the last page
+        media_box = last_page.MediaBox
+
+        # Create a new blank page with the same dimensions as the last page
+        blank_page = pikepdf.Page(pikepdf.Dictionary(MediaBox=media_box))
+
+        # Add the blank page to the end of the PDF
+        pdf.pages.append(blank_page)
+
+        # Overwrite the original PDF with the modified version
+        pdf.save(pdf_path)
+
+
 class ALAddendumField(DAObject):
     """
     Represents a field with attributes determining its display in an addendum, typically for PDF templates.
@@ -1441,6 +1486,7 @@ 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.
 
     Examples:
         Given three documents: `Cover page`, `Main motion form`, and `Notice of Interpreter Request`,
@@ -1481,6 +1527,7 @@ class ALDocumentBundle(DAList):
         refresh: bool = True,
         pdfa: bool = False,
         append_matching_suffix: bool = True,
+        ensure_parity: Optional[Literal["even", "odd"]] = None,
     ) -> Optional[DAFile]:
         """
         Returns a consolidated PDF of all enabled documents in the bundle.
@@ -1491,6 +1538,8 @@ class ALDocumentBundle(DAList):
             pdfa (bool): If True, generates a PDF/A compliant document, defaults to False.
             append_matching_suffix (bool): Flag to determine if matching suffix should be appended to file name, default is True.
                                             Used primarily to enhance automated tests.
+            ensure_parity (Optional[Literal["even", "odd"]]): Ensures the number of pages in the PDF is even or odd. If omitted,
+                no parity is enforced. Defaults to None.
 
         Returns:
             Optional[DAFile]: Combined PDF file or None if no documents are enabled.
@@ -1533,6 +1582,19 @@ class ALDocumentBundle(DAList):
             )
         pdf.title = self.title
         setattr(self.cache, safe_key, pdf)
+
+        if hasattr(self, "default_parity") and not ensure_parity:
+            ensure_parity = self.default_parity
+
+        if ensure_parity not in [None, "even", "odd"]:
+            raise ValueError("ensure_parity must be either 'even', 'odd' or None")
+
+        if ensure_parity:  # Check for odd/even requirement
+            if pdf_page_parity(pdf.path()) == ensure_parity:
+                return pdf
+            else:
+                add_blank_page(pdf.path())
+
         return pdf
 
     def __str__(self) -> str:

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble/AssemblyLine/al_general.py

@@ -1672,6 +1672,36 @@ class ALIndividual(Individual):
             return capitalize(output)
         return output
 
+    def name_full(self) -> str:
+        """Returns the individual's full name.
+
+        Returns:
+            str: The individual's full name.
+        """
+        return self.name.full(middle="full")
+
+    def name_initials(self) -> str:
+        """
+        Returns the individual's name with the middle name as an initial.
+        Equivalent to `name.full(middle="initial")`, which is also the default.
+        Defined only to make it possible to be explicit about the name form.
+
+        Returns:
+            str: The individual's name with the middle name as an initial.
+        """
+        return self.name.full(middle="initial")
+
+    def name_short(self) -> str:
+        """
+        Returns the individual's name without any middle name.
+
+        Equivalent to self.name.firstlast()
+
+        Returns:
+            str: The individual'
+        """
+        return self.name.firstlast()
+
 
 # (DANav isn't in public DA API, but currently in functions.py)
 def section_links(nav) -> List[str]:  # type: ignore

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble/AssemblyLine/data/questions/al_code.yml

@@ -186,13 +186,16 @@ code: |
     # If the user role was set to "unknown" at the time wizard run
     user_role = user_ask_role
 ---
-# Old HTML for ALKiln deprecated 3-column Story Tables.
+# HTML for interviews using ALKiln tests at ALKiln
+# Necessary for servers that set their `restrict input variables` config value to `True`
+# If you are using al_package_unstyled.yml, copy it into your `default screen parts: post`
 template: alkiln_trigger_html
 content: |
   <div data-variable="${ encode_name(str( user_info().variable )) }" id="trigger" aria-hidden="true" style="display: none;"></div>
 ---
 # HTML for interviews using ALKiln tests at ALKiln versions 5.9.0 and above.
-# If you are using al_package_unstyled.yml, include it in your `default screen parts: post`
+# Necessary for interviews that use docassemble generic objects or index variables
+# If you are using al_package_unstyled.yml, copy it into your `default screen parts: post`
 template: alkiln_proxy_html
 content: |
   <div id="alkiln_proxy_var_values"

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble/AssemblyLine/data/questions/al_visual.yml

@@ -41,10 +41,10 @@ default screen parts:
   corner back button label: |
     Undo
   pre: |
-    % if get_config('debug'):
-    `id: ${ user_info().question_id }`  
-    `Variable triggering this screen: ${ user_info().variable }`  
-    `Package: ${ user_info().package } ${ package_version_number }; ${ al_version }`
+    % if get_config('debug') and not url_args.get("hide_hud", "").lower() in ["1", "on", "true", "yes"]:
+    `id: ${ user_info().question_id }`[BR]
+    `Variable: ${ user_info().variable }`[BR]
+    `Version: ${ user_info().package.replace("docassemble.", "") + " " if not user_info().package.startswith("docassemble.playground") else "" }${ package_version_number }; ${ al_version }`
     <div data-variable="${ encode_name(str( user_info().variable )) }" id="sought_variable" aria-hidden="true" style="display: none;"></div>
     % endif
   # We need both pre and post until old interviews are updated to v2 of the testing framework or v1 of the testing framework is updated. In future, we will need this in `post` so that it will work on signature pages.

docassemble_assemblyline-2.28.0/docassemble/AssemblyLine/data/questions/test_bundle_parity.yml

@@ -0,0 +1,79 @@
+---
+include:
+  - assembly_line.yml
+---
+objects:
+  - the_doc: ALDocument.using(
+        title="The document", 
+        filename="the_document", 
+        enabled=True, 
+        has_addendum=False
+      )
+---
+objects:
+  - even_bundle: ALDocumentBundle.using(
+          title="Even bundle",
+          filename="the_bundle",
+          elements=[
+            the_doc
+          ],
+          default_parity="even",
+          enabled=True
+      )
+  - odd_bundle: ALDocumentBundle.using(
+          title="Even bundle",
+          filename="the_bundle",
+          elements=[
+            the_doc,
+            the_doc
+          ],
+          enabled=True
+      )
+  - bundle_with_default: ALDocumentBundle.using(
+          title="Even bundle",
+          filename="the_bundle",
+          elements=[
+            the_doc
+          ],
+          default_parity="even",
+          enabled=True 
+      )
+
+---
+objects:
+  - bundle_of_bundles: ALDocumentBundle.using(
+          title="Bundle of bundles",
+          filename="the_bundle",
+          elements=[
+            even_bundle,
+            bundle_with_default
+          ],
+          enabled=True
+      )
+
+---
+attachment:
+  variable name: the_doc[i]
+  content: |
+    Test content
+---
+mandatory: True
+question: |
+  About to make a PDF
+continue button field: the_field
+---
+mandatory: True
+question: |
+  Download
+subquestion: |
+  # Should be even
+  ${ even_bundle.as_pdf(ensure_parity="even") }
+
+  # should be odd
+  ${ odd_bundle.as_pdf(ensure_parity="odd") }
+
+  # should be even
+  ${ bundle_with_default.as_pdf() }
+
+  # Should be even
+  ${ bundle_of_bundles.as_pdf() }

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble/AssemblyLine/test_al_general.py

@@ -427,6 +427,15 @@ class TestALIndividual(unittest.TestCase):
         with self.assertRaises(DAAttributeError):
             self.individual.pronoun_objective()
 
+    def test_name_methods(self):
+        self.individual.name.first = "John"
+        self.individual.name.middle = "Jacob"
+        self.individual.name.last = "Jingleheimer"
+
+        self.assertEqual(self.individual.name_full(), "John Jacob Jingleheimer")
+        self.assertEqual(self.individual.name_initials(), "John J. Jingleheimer")
+        self.assertEqual(self.individual.name_short(), "John Jingleheimer")
+
 
 class test_get_visible_al_nav_items(unittest.TestCase):
     def test_case_1(self):

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0/docassemble.AssemblyLine.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docassemble.AssemblyLine
-Version: 2.27.2
+Version: 2.28.0
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
 Author-email: qsteenhuis@suffolk.edu

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/docassemble.AssemblyLine.egg-info/SOURCES.txt

@@ -49,6 +49,7 @@ docassemble/AssemblyLine/data/questions/test_alcourts.yml
 docassemble/AssemblyLine/data/questions/test_aldocument.yml
 docassemble/AssemblyLine/data/questions/test_alexhibit.yml
 docassemble/AssemblyLine/data/questions/test_alexhibit_maxsize.yml
+docassemble/AssemblyLine/data/questions/test_bundle_parity.yml
 docassemble/AssemblyLine/data/questions/test_question_library.yml
 docassemble/AssemblyLine/data/sources/README.md
 docassemble/AssemblyLine/data/sources/es-words.yml

{docassemble.AssemblyLine-2.27.2 → docassemble_assemblyline-2.28.0}/setup.py

@@ -44,7 +44,7 @@ def find_package_data(where='.', package='', exclude=standard_exclude, exclude_d
     return out
 
 setup(name='docassemble.AssemblyLine',
-      version='2.27.2',
+      version='2.28.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',

docassemble.AssemblyLine-2.27.2/docassemble/AssemblyLine/__init__.py

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