docassemble.AssemblyLine 2.28.0__tar.gz → 2.28.1__tar.gz

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

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

docassemble_assemblyline-2.28.1/docassemble/AssemblyLine/__init__.py

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

{docassemble_assemblyline-2.28.0 → docassemble_assemblyline-2.28.1}/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, Dict, List, Optional, Union, Set
+from typing import Any, Callable, Dict, List, Mapping, Optional, Union, Set
 import pandas as pd
 import docassemble.base.functions
 from docassemble.base.util import (
@@ -205,6 +205,7 @@ class ALCourtLoader(DAObject):
 
     Attributes:
         filename (str): Path to the file containing court information.
+        converters (Dict[str, Callable]): A dictionary of functions to apply to columns in the dataframe.
     """
 
     def init(self, *pargs, **kwargs):
@@ -413,6 +414,8 @@ class ALCourtLoader(DAObject):
 
         The method determines the file type (.csv, .xlsx, or .json) based on its extension and reads it accordingly.
 
+        If the "callable" attribute is defined on the instance, it will be used to convert the data in the dataframe.
+
         Returns:
             pd.DataFrame: A dataframe containing the list of courts.
 
@@ -429,11 +432,20 @@ class ALCourtLoader(DAObject):
         else:
             load_path = str(self.filename)
 
+        def convert_zip(z: Any) -> str:
+            return str(z).zfill(5)
+
+        merged_converters: Dict[str, Callable[[object], object]] = {
+            "address_zip": convert_zip
+        }
+        if hasattr(self, "converters") and self.converters:
+            assert isinstance(self.converters, dict)
+            merged_converters.update(self.converters)
         to_load = path_and_mimetype(load_path)[0]
         if self.filename.lower().endswith(".xlsx"):
-            df = pd.read_excel(to_load)
+            df = pd.read_excel(to_load, converters=merged_converters)  # type: ignore
         elif self.filename.lower().endswith(".csv"):
-            df = pd.read_csv(to_load)
+            df = pd.read_csv(to_load, converters=merged_converters)  # type: ignore
         elif self.filename.lower().endswith(".json"):
             # TODO: we may need to normalize a JSON file
             df = pd.read_json(to_load)

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

@@ -2244,8 +2244,12 @@ class ALDocumentBundle(DAList):
             return send_email(
                 to=to,
                 template=template,
-                attachments=set(
-                    self.as_editable_list(key=key) + self.as_pdf_list(key=key)
+                # Add both DOCX and PDF versions, but if it's not possible to be a DOCX don't add the PDF
+                # twice
+                attachments=list(
+                    dict.fromkeys(
+                        self.as_editable_list(key=key) + self.as_pdf_list(key=key)
+                    )
                 ),
                 **kwargs,
             )

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

@@ -425,7 +425,13 @@ class ALAddress(Address):
             else:
                 output += ", " + str(self.state)
         if hasattr(self, "zip") and self.zip:
-            output += " " + str(self.zip)
+            current_country = (
+                self.country if hasattr(self, "country") else get_country()
+            )
+            if current_country == "US":
+                output += " " + str(self.zip).zfill(5)
+            else:
+                output += " " + str(self.zip)
         elif hasattr(self, "postal_code") and self.postal_code:
             output += " " + str(self.postal_code)
         if (
@@ -508,7 +514,13 @@ class ALAddress(Address):
             else:
                 output += ", " + str(self.state)
         if hasattr(self, "zip") and self.zip:
-            output += " " + str(self.zip)
+            current_country = (
+                self.country if hasattr(self, "country") else get_country()
+            )
+            if current_country == "US":
+                output += " " + str(self.zip).zfill(5)
+            else:
+                output += " " + str(self.zip)
         elif hasattr(self, "postal_code") and self.postal_code:
             output += " " + str(self.postal_code)
         return output
@@ -576,7 +588,13 @@ class ALAddress(Address):
             else:
                 output += ", " + str(self.state)
         if hasattr(self, "zip") and self.zip:
-            output += " " + str(self.zip)
+            current_country = (
+                self.country if hasattr(self, "country") else get_country()
+            )
+            if current_country == "US":
+                output += " " + str(self.zip).zfill(5)
+            else:
+                output += " " + str(self.zip)
         elif hasattr(self, "postal_code") and self.postal_code:
             output += " " + str(self.postal_code)
         if (
@@ -1267,9 +1285,13 @@ class ALIndividual(Individual):
 
         If the individual has selected the "self-described" option, it will use their custom input.
 
+        Can be formatted however the author likes.
+
         Returns:
             set: A set of strings representing the individual's pronouns.
         """
+        if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
+            return {self.pronouns}
         if self.pronouns.all_false():
             return {str(self.pronoun_prefer_not_to_say_label)}
         pronouns = set(self.pronouns.true_values()) - {"self-described"}
@@ -1277,6 +1299,16 @@ class ALIndividual(Individual):
             pronouns = pronouns.union(self.pronouns_self_described.splitlines())
         return pronouns
 
+    def list_pronouns(self) -> str:
+        """
+        Retrieve a formatted string of the individual's pronouns, arranged with
+        the comma_list() function.
+
+        Returns:
+            str: A formatted string of the individual's pronouns.
+        """
+        return comma_list(sorted(self.get_pronouns()))
+
     def language_fields(
         self,
         choices: Optional[List[Dict[str, str]]] = None,
@@ -1500,32 +1532,38 @@ class ALIndividual(Individual):
         Returns:
             str: The appropriate pronoun.
         """
+        # Developers can do funky things; be a little flexible
+        if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
+            pronouns = DADict(elements={self.pronouns.lower(): True})
+        else:
+            pronouns = self.pronouns
+
         if self == this_thread.global_vars.user:
             output = word("you", **kwargs)
         elif (
             hasattr(self, "pronouns")
-            and isinstance(self.pronouns, DADict)
-            and len(self.pronouns.true_values()) == 1
+            and isinstance(pronouns, DADict)
+            and len(pronouns.true_values()) == 1
             and (
                 (
-                    self.pronouns.true_values()[0]
+                    pronouns.true_values()[0]
                     in ["she/her/hers", "he/him/his", "they/them/theirs", "ze/zir/zirs"]
                 )
                 or (
-                    self.pronouns.get("self-described")
+                    pronouns.get("self-described")
                     and has_parsable_pronouns(self.pronouns_self_described)
                 )
             )
         ):
-            if self.pronouns["she/her/hers"]:
+            if pronouns.get("she/her/hers"):
                 output = word("her", **kwargs)
-            elif self.pronouns["he/him/his"]:
+            elif pronouns.get("he/him/his"):
                 output = word("him", **kwargs)
-            elif self.pronouns["they/them/theirs"]:
+            elif pronouns.get("they/them/theirs"):
                 output = word("them", **kwargs)
-            elif self.pronouns["ze/zir/zirs"]:
+            elif pronouns.get("ze/zir/zirs"):
                 output = word("zir", **kwargs)
-            elif self.pronouns.get("self-described"):
+            elif pronouns.get("self-described"):
                 output = parse_custom_pronouns(self.pronouns_self_described)["o"]
         elif hasattr(self, "person_type") and self.person_type in [
             "business",
@@ -1567,34 +1605,39 @@ class ALIndividual(Individual):
         Returns:
             str: The appropriate possessive phrase.
         """
+        if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
+            pronouns = DADict(elements={self.pronouns.lower(): True})
+        else:
+            pronouns = self.pronouns
+
         if self == this_thread.global_vars.user and (
             "thirdperson" not in kwargs or not kwargs["thirdperson"]
         ):
             output = your(target, **kwargs)
         elif (
             hasattr(self, "pronouns")
-            and isinstance(self.pronouns, DADict)
-            and len(self.pronouns.true_values()) == 1
+            and isinstance(pronouns, DADict)
+            and len(pronouns.true_values()) == 1
             and (
                 (
-                    self.pronouns.true_values()[0]
+                    pronouns.true_values()[0]
                     in ["she/her/hers", "he/him/his", "they/them/theirs", "ze/zir/zirs"]
                 )
                 or (
-                    self.pronouns.get("self-described")
+                    pronouns.get("self-described")
                     and has_parsable_pronouns(self.pronouns_self_described)
                 )
             )
         ):
-            if self.pronouns["she/her/hers"]:
+            if pronouns.get("she/her/hers"):
                 output = her(target, **kwargs)
-            elif self.pronouns["he/him/his"]:
+            elif pronouns.get("he/him/his"):
                 output = his(target, **kwargs)
-            elif self.pronouns["they/them/theirs"]:
+            elif pronouns.get("they/them/theirs"):
                 output = their(target, **kwargs)
-            elif self.pronouns["ze/zir/zirs"]:
+            elif pronouns.get("ze/zir/zirs"):
                 output = word("zir", **kwargs) + " " + target
-            elif self.pronouns.get("self-described"):
+            elif pronouns.get("self-described"):
                 output = (
                     parse_custom_pronouns(self.pronouns_self_described)["p"]
                     + " "
@@ -1628,34 +1671,39 @@ class ALIndividual(Individual):
         Returns:
             str: The appropriate subjective pronoun.
         """
+        if hasattr(self, "pronouns") and isinstance(self.pronouns, str):
+            pronouns = DADict(elements={self.pronouns.lower(): True})
+        else:
+            pronouns = self.pronouns
+
         if self == this_thread.global_vars.user and (
             "thirdperson" not in kwargs or not kwargs["thirdperson"]
         ):
             output = word("you", **kwargs)
         elif (
             hasattr(self, "pronouns")
-            and isinstance(self.pronouns, DADict)
-            and len(self.pronouns.true_values()) == 1
+            and isinstance(pronouns, DADict)
+            and len(pronouns.true_values()) == 1
             and (
                 (
-                    self.pronouns.true_values()[0]
+                    pronouns.true_values()[0]
                     in ["she/her/hers", "he/him/his", "they/them/theirs", "ze/zir/zirs"]
                 )
                 or (
-                    self.pronouns.get("self-described")
+                    pronouns.get("self-described")
                     and has_parsable_pronouns(self.pronouns_self_described)
                 )
             )
         ):
-            if self.pronouns["she/her/hers"]:
+            if pronouns.get("she/her/hers"):
                 output = word("she", **kwargs)
-            elif self.pronouns["he/him/his"]:
+            elif pronouns.get("he/him/his"):
                 output = word("he", **kwargs)
-            elif self.pronouns["they/them/theirs"]:
+            elif pronouns.get("they/them/theirs"):
                 output = word("they", **kwargs)
-            elif self.pronouns["ze/zir/zirs"]:
+            elif pronouns.get("ze/zir/zirs"):
                 output = word("ze", **kwargs)
-            elif self.pronouns.get("self-described"):
+            elif pronouns.get("self-described"):
                 output = parse_custom_pronouns(self.pronouns_self_described)["s"]
         elif hasattr(self, "person_type") and self.person_type in [
             "business",
@@ -2078,7 +2126,7 @@ def get_visible_al_nav_items(
 
         # For dictionaries at top level
         item_copy = deepcopy(item)
-        if not item_copy.pop("hidden", False):  # if not hidden
+        if not str(item_copy.pop("hidden", "False")).lower() == "true":  # if not hidden
             for key, val in item_copy.items():
                 if isinstance(val, list):  # if value of a key is a list
                     new_sublist: List[Union[str, dict]] = []
@@ -2087,8 +2135,10 @@ def get_visible_al_nav_items(
                         if isinstance(subitem, str):
                             new_sublist.append(subitem)
                         # Add dictionaries if not hidden
-                        elif isinstance(subitem, dict) and not subitem.pop(
-                            "hidden", False
+                        elif (
+                            isinstance(subitem, dict)
+                            and not str(subitem.pop("hidden", "False")).lower()
+                            == "true"
                         ):
                             new_sublist.append(subitem)
                     item_copy[key] = new_sublist

{docassemble_assemblyline-2.28.0 → docassemble_assemblyline-2.28.1}/docassemble/AssemblyLine/data/questions/ql_baseline.yml

@@ -71,19 +71,17 @@ subquestion: |
 fields:
   - note: |
       ${ display_template(al_terms_of_use, scrollable=True) }
-  - To continue, you must accept our terms of use: acknowledged_information_use
-    datatype: checkboxes
-    none of the above: False
-    minlength: 1
-    choices:
-      - I accept the terms of use.
-    validation messages:
-      minlength: |
-        You cannot continue unless you agree to the terms of use.
+      To continue, you must accept our terms of use
+  - I accept the terms of use: acknowledged_information_use
+    datatype: yesnowide
+    grid: 8
 continue button field: al_intro_screen
 terms:
   green words: |
     Green words are legal terms or a short way of referring to something that needs more explanation. The definition or explanation pops up when you tap the green words. 
+validation code: |
+  if not acknowledged_information_use:
+    validation_error("You must accept the terms of use to continue.", field="acknowledged_information_use")
 ---
 ##### Backwards compatibility #####
 code: |

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

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

{docassemble_assemblyline-2.28.0 → docassemble_assemblyline-2.28.1}/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.28.0',
+      version='2.28.1',
       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.28.0/docassemble/AssemblyLine/__init__.py

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