docassemble.AssemblyLine 4.4.0__tar.gz → 4.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.4.0
+Version: 4.5.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

docassemble_assemblyline-4.5.0/docassemble/AssemblyLine/__init__.py

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

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

@@ -1581,6 +1581,7 @@ class ALDocumentBundle(DAList):
             self.auto_gather = False
         if "gathered" not in kwargs:
             self.gathered = True
+        self._set_default_attributes()
         self.initializeAttribute("cache", DALazyAttribute)
         self.always_enabled = hasattr(self, "enabled") and self.enabled
         # Pre-cache some DALazyTemplates we set up to aid translation that won't
@@ -1589,6 +1590,24 @@ class ALDocumentBundle(DAList):
             # When the key is "preview", append it to the file name
             self.suffix_to_append = "preview"
 
+    def _set_default_attributes(self) -> None:
+        if not hasattr(self, "add_page_numbers"):
+            self.add_page_numbers = False
+        if not hasattr(self, "page_number_prefix"):
+            self.page_number_prefix = ""
+        if not hasattr(self, "page_number_start"):
+            self.page_number_start = 1
+        if not hasattr(self, "page_number_digits"):
+            self.page_number_digits = 5
+        if not hasattr(self, "page_number_area"):
+            self.page_number_area = None
+        if not hasattr(self, "page_number_font_size"):
+            self.page_number_font_size = 10
+        if not hasattr(self, "page_number_offset_horizontal"):
+            self.page_number_offset_horizontal = 15
+        if not hasattr(self, "page_number_offset_vertical"):
+            self.page_number_offset_vertical = 15
+
     def as_pdf(
         self,
         key: str = "final",
@@ -1648,6 +1667,17 @@ class ALDocumentBundle(DAList):
                 filename=f"{base_name(self.filename)}{append_suffix}.pdf",
                 pdfa=pdfa,
             )
+        if hasattr(self, "add_page_numbers") and self.add_page_numbers:
+            self._set_default_attributes()
+            pdf.bates_number(
+                prefix=self.page_number_prefix,
+                start=self.page_number_start,
+                digits=self.page_number_digits,
+                area=self.page_number_area,
+                font_size=self.page_number_font_size,
+                offset_horizontal=self.page_number_offset_horizontal,
+                offset_vertical=self.page_number_offset_vertical,
+            )
         pdf.title = self.title
         setattr(self.cache, safe_key, pdf)
 
@@ -2385,6 +2415,7 @@ class ALDocumentBundle(DAList):
         label: str = "Send",
         icon: str = "envelope",
         preferred_formats: Optional[Union[str, List[str]]] = None,
+        email_legend_class: str = "h4",
     ) -> str:
         """
         Generate HTML for an input box and button that allows someone to send the bundle
@@ -2404,6 +2435,8 @@ class ALDocumentBundle(DAList):
             icon (str, optional): The Fontawesome icon for the button. Defaults
                 to "envelope".
             preferred_formats (Optional[Union[str,List[str]]], optional): A list of allowed formats for the document. Defaults to "pdf" if not specified.
+            email_legend_class (str, optional): CSS class applied to the email
+                section legend. Defaults to "h4".
 
         Returns:
             str: The generated HTML string for the input box and button.
@@ -2443,7 +2476,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">{str(self.get_email_copy)}</legend> 
+    <legend class="{email_legend_class} al_doc_email_header">{str(self.get_email_copy)}</legend> 
     """
         # "Editable" checkbox
         if (
@@ -2735,9 +2768,14 @@ class ALExhibit(DAObject):
         self,
         *,
         refresh: bool = False,
-        prefix: str = "",
         pdfa: bool = False,
         add_page_numbers: bool = True,
+        page_number_prefix: str = "",
+        page_number_digits: int = 5,
+        page_number_area=None,
+        page_number_font_size: float = 10,
+        page_number_offset_horizontal: float = 15,
+        page_number_offset_vertical: float = 15,
         add_cover_page: bool = True,
         filename: Optional[str] = None,
         append_matching_suffix: bool = True,
@@ -2749,9 +2787,14 @@ class ALExhibit(DAObject):
 
         Args:
             refresh (bool): If True, forces the exhibit to refresh before generating the PDF. (unused, provided for signature compatibility)
-            prefix (str): Prefix for Bates numbering if 'add_page_numbers' is True.
             pdfa (bool): If True, the generated PDF will be in PDF/A format.
             add_page_numbers (bool): If True, apply Bates numbering starting from 'self.start_page'.
+            page_number_prefix (str): If add_page_numbers is True, this gets added to the beginning on the bates number each page (e.g. `EX-`).
+            page_number_digits (int): How many digits (i.e. leading 0s) that the bates number will have
+            page_number_area (str): Where on the page the bates number will go ("TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT" (default))
+            page_number_font_size (float): How big the bates page number will be in points (default is 10).
+            page_number_offset_horizontal (float): The number of pixels that the bates page number is offset from the left / right of the page.
+            page_number_offset_vertical (float): The number of pixels that the bates page number is offset from the top / bottom of the page.
             add_cover_page (bool): If True, prepend the exhibit with a cover page.
             filename (Optional[str]): Custom filename for the generated PDF. Default is "exhibits.pdf".
             append_matching_suffix (bool): If True, appends a suffix to the filename based on certain matching criteria.
@@ -2779,7 +2822,15 @@ class ALExhibit(DAObject):
             )
 
         if add_page_numbers:
-            concatenated_pages.bates_number(prefix=prefix, start=self.start_page)
+            concatenated_pages.bates_number(
+                start=self.start_page,
+                prefix=page_number_prefix,
+                digits=page_number_digits,
+                area=page_number_area,
+                font_size=page_number_font_size,
+                offset_horizontal=page_number_offset_horizontal,
+                offset_vertical=page_number_offset_vertical,
+            )
 
         setattr(self._cache, safe_key, concatenated_pages)
         return getattr(self._cache, safe_key)
@@ -2913,6 +2964,12 @@ class ALExhibitList(DAList):
         filename="file.pdf",
         pdfa: bool = False,
         add_page_numbers: bool = False,
+        page_number_prefix: str = "",
+        page_number_digits: int = 5,
+        page_number_area=None,
+        page_number_font_size: float = 10,
+        page_number_offset_horizontal: float = 15,
+        page_number_offset_vertical: float = 15,
         toc_pages: int = 0,
         append_matching_suffix: bool = True,
     ) -> DAFile:
@@ -2923,6 +2980,12 @@ class ALExhibitList(DAList):
             filename (str): Desired filename for the generated PDF.
             pdfa (bool): If True, generates the PDF in PDF/A format.
             add_page_numbers (bool): If True, adds page numbers to the generated PDF.
+            page_number_prefix (str): What the bates number added to each page should start with (e.g. `EX-`).
+            page_number_digits (int): How many digits (i.e. leading 0s) that the bates number will have
+            page_number_area (str): Where on the page the bates number will go ("TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT" (default))
+            page_number_font_size (float): How big the bates page number will be in points (default is 10).
+            page_number_offset_horizontal (float): The number of pixels that the bates page number is offset from the left / right of the page.
+            page_number_offset_vertical (float): The number of pixels that the bates page number is offset from the top / bottom of the page.
             toc_pages (int): Expected number of pages in the table of contents.
             append_matching_suffix (bool): If True, appends matching suffix to the filename.
 
@@ -2934,12 +2997,19 @@ class ALExhibitList(DAList):
                 exhibit.cover_page
         if self.include_table_of_contents and toc_pages != 1:
             self._update_page_numbers(toc_guess_pages=toc_pages)
+        if not page_number_prefix and self.bates_prefix:
+            page_number_prefix = self.bates_prefix
         return pdf_concatenate(
             [
                 exhibit.as_pdf(
                     add_cover_page=self.include_exhibit_cover_pages,
                     add_page_numbers=add_page_numbers,
-                    prefix=self.bates_prefix,
+                    page_number_prefix=page_number_prefix,
+                    page_number_digits=page_number_digits,
+                    page_number_area=page_number_area,
+                    page_number_font_size=page_number_font_size,
+                    page_number_offset_horizontal=page_number_offset_horizontal,
+                    page_number_offset_vertical=page_number_offset_vertical,
                 )
                 for exhibit in self
             ],
@@ -3072,12 +3142,19 @@ class ALExhibitDocument(ALDocument):
     has_addendum: bool
     auto_labeler: Callable
     auto_ocr: bool
+    # Deprecated
     bates_prefix: str
     maximum_size: int
     maximum_size_per_doc: int
     suffix_to_append: str
     exhibits: ALExhibitList
     table_of_contents: DAFile
+    page_number_prefix: str
+    page_number_digits: int
+    page_number_area: str | None
+    page_number_font_size: float
+    page_number_offset_horizontal: float
+    page_number_offset_vertical: float
 
     def init(self, *pargs, **kwargs) -> None:
         """Standard DAObject init method.
@@ -3092,8 +3169,6 @@ class ALExhibitDocument(ALDocument):
             self.exhibits.auto_labeler = self.auto_labeler
         if hasattr(self, "auto_ocr"):
             self.exhibits.auto_ocr = self.auto_ocr
-        if hasattr(self, "bates_prefix"):
-            self.exhibits.bates_prefix = self.bates_prefix
         if hasattr(self, "include_exhibit_cover_pages"):
             self.exhibits.include_exhibit_cover_pages = self.include_exhibit_cover_pages
         else:
@@ -3111,13 +3186,30 @@ class ALExhibitDocument(ALDocument):
         else:
             self.include_table_of_contents = True
             self.exhibits.include_table_of_contents = True
+        if hasattr(self, "bates_prefix"):
+            self.exhibits.bates_prefix = self.bates_prefix
         if not hasattr(self, "add_page_numbers"):
             self.add_page_numbers = False
+        self._set_default_attributes()
         self.has_addendum = False
         if not hasattr(self, "suffix_to_append"):
             # When the key is "preview", append it to the file name
             self.suffix_to_append = "preview"
 
+    def _set_default_attributes(self) -> None:
+        if not hasattr(self, "page_number_prefix"):
+            self.page_number_prefix = ""
+        if not hasattr(self, "page_number_digits"):
+            self.page_number_digits = 5
+        if not hasattr(self, "page_number_area"):
+            self.page_number_area = None
+        if not hasattr(self, "page_number_font_size"):
+            self.page_number_font_size = 10
+        if not hasattr(self, "page_number_offset_horizontal"):
+            self.page_number_offset_horizontal = 15
+        if not hasattr(self, "page_number_offset_vertical"):
+            self.page_number_offset_vertical = 15
+
     def has_overflow(self) -> bool:
         """
         Check if there is any overflow in the document.
@@ -3192,12 +3284,21 @@ class ALExhibitDocument(ALDocument):
             filename = base_name(self.filename) + ".pdf"
 
         if len(self.exhibits):
+            self._set_default_attributes()
             if self.include_table_of_contents:
                 toc_pages = self.table_of_contents.num_pages()
                 return pdf_concatenate(
                     self.table_of_contents,
                     self.exhibits.as_pdf(
-                        add_page_numbers=self.add_page_numbers, toc_pages=toc_pages
+                        add_page_numbers=self.add_page_numbers,
+                        page_number_prefix=self.page_number_prefix,
+                        page_number_digits=self.page_number_digits,
+                        page_number_area=self.page_number_area,
+                        page_number_font_size=self.page_number_font_size,
+                        page_number_offset_horizontal=self.page_number_offset_horizontal,
+                        page_number_offset_vertical=self.page_number_offset_vertical,
+                        toc_pages=toc_pages,
+                        pdfa=pdfa,
                     ),
                     filename=filename,
                     pdfa=pdfa,
@@ -3205,6 +3306,12 @@ class ALExhibitDocument(ALDocument):
             else:
                 return self.exhibits.as_pdf(
                     add_page_numbers=self.add_page_numbers,
+                    page_number_prefix=self.page_number_prefix,
+                    page_number_digits=self.page_number_digits,
+                    page_number_area=self.page_number_area,
+                    page_number_font_size=self.page_number_font_size,
+                    page_number_offset_horizontal=self.page_number_offset_horizontal,
+                    page_number_offset_vertical=self.page_number_offset_vertical,
                     filename=filename,
                     pdfa=pdfa,
                 )

{docassemble_assemblyline-4.4.0 → docassemble_assemblyline-4.5.0}/docassemble/AssemblyLine/al_general.py

@@ -1914,7 +1914,7 @@ class ALIndividual(Individual):
             if len(pronouns_to_use) > 0:
                 output = "/".join(pronouns_to_use)
             else:
-                output = default
+                output = f"{default}'s {target}"
         elif hasattr(self, "person_type") and self.person_type in [
             "business",
             "organization",
@@ -1928,7 +1928,7 @@ class ALIndividual(Individual):
             else:
                 output = their(target, **kwargs)
         else:
-            output = default
+            output = f"{default}'s {target}"
 
         if "capitalize" in kwargs and kwargs["capitalize"]:
             return capitalize(output)

{docassemble_assemblyline-4.4.0 → docassemble_assemblyline-4.5.0}/docassemble/AssemblyLine/data/questions/al_visual.yml

@@ -110,9 +110,16 @@ data from code:
     label: str(al_load_answer_set_string)
     hidden: not get_config('assembly line',{}).get('enable answer sets')
   - url: |
-      url_action('al_error_action_download_screen')
-    label: str(al_download_answer_set_string)
-    hidden: (not get_config('assembly line',{}).get('enable answer set imports')) or (_internal.get('steps') < 2)
+      url_ask(["al_sessions_json_file", {"recompute": ["al_sessions_import_json"]}, "al_sessions_load_status"])
+    label: str(al_import_answer_set_string)
+    hidden: |
+      not (
+        (
+          get_config('assembly line',{}).get('enable answer sets')
+          and get_config('assembly line',{}).get('enable answer set imports')
+        )
+        or (user_logged_in() and user_has_privilege('admin'))
+      )
 ---
 template: al_start_over_string
 content: >-
@@ -134,9 +141,9 @@ template: al_load_answer_set_string
 content: >-
   Load answer set
 ---
-template: al_download_answer_set_string
+template: al_import_answer_set_string
 content: >-
-  Download answer set
+  Import answer set
 ---
 event: al_exit_logout
 code: |

{docassemble_assemblyline-4.4.0 → docassemble_assemblyline-4.5.0}/docassemble/AssemblyLine/data/questions/assembly_line.yml

@@ -1,4 +1,4 @@
-# For usage, see https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/framework/magic_variables
+# For usage, see https://assemblyline.suffolklitlab.org/docs/components/AssemblyLine/magic_variables
 ---
 include:
   - al_language.yml
@@ -19,4 +19,4 @@ modules:
   - .al_document
   - .al_courts
   - docassemble.GithubFeedbackForm.github_issue
-  
+  

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

@@ -18,7 +18,7 @@ comment: |
       new form label: Start a new form
       new form url: https://courtformsonline.org
       logo url: null # Defaults to `app homepage`
-      logo image url: https://app.yourserver.org/packagestatic/docassemble.AssemblyLine/ma_logo.png
+      logo image url: https://app.example.org/packagestatic/docassemble.AssemblyLine/ma_logo.png
       logo image alt: Logo
       answer sets title: Answer sets
       logo title row 1: null # Defaults to `interview page title`
@@ -490,4 +490,4 @@ code: |
 event: delete_results_action
 code: |
   undefine("limit_filename")
-  undefine("search_keyword")
+  undefine("search_keyword")

{docassemble_assemblyline-4.4.0 → docassemble_assemblyline-4.5.0}/docassemble/AssemblyLine/data/questions/test_aldocument.yml

@@ -31,7 +31,7 @@ code: |
 ---
 objects:
   # No addenda, all start enabled
-  - multi_bundle_1: ALDocumentBundle.using(elements=[pdf_1, docx_1, notice_to_quit], title="Multiple docs 1", filename="multi_bundle_1" )
+  - multi_bundle_1: ALDocumentBundle.using(elements=[pdf_1, docx_1, notice_to_quit], title="Multiple docs 1", filename="multi_bundle_1", add_page_numbers=True, page_numbers_font_size=20 )
   - single_pdf_bundle_1: ALDocumentBundle.using(elements=[pdf_1], title="One pdf", filename="single_pdf_1" )
   - single_docx_bundle_1: ALDocumentBundle.using(elements=[docx_1], title="One docx", filename="single_docx_1" )
 ---
@@ -341,9 +341,9 @@ subquestion: |
 
   Send button which allows the user to edit the email address.
   
-  multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" )
+  multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search", email_legend_class="h5" )
   
-  ${ multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" ) }
+  ${ multi_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search", email_legend_class="h5" ) }
   
   ---
   single_pdf_bundle_1.send_button_html( key="test_key", show_editable_checkbox=False, label="Custom send label", icon="search" )
@@ -380,4 +380,4 @@ subquestion: |
 id: end aldocument tests
 event: end_aldocument_tests
 question: The end of ALDocument tests
----
+---

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

@@ -1714,7 +1714,7 @@ def update_session_metadata(
 
     # 2) Derive two signed 32‑bit ints from MD5(session_id|filename|tags)
     key_string = f"{session_id}|{filename}|{metadata_key_name}"
-    digest = hashlib.md5(key_string.encode("utf-8")).digest()
+    digest = hashlib.md5(key_string.encode("utf-8"), usedforsecurity=False).digest()
     high_u32, low_u32 = struct.unpack(">II", digest[:8])
 
     def to_signed_32(x: int) -> int:

{docassemble_assemblyline-4.4.0 → docassemble_assemblyline-4.5.0}/docassemble/AssemblyLine/test_al_general.py

@@ -418,6 +418,19 @@ class TestALIndividual(unittest.TestCase):
             self.individual.pronoun_possessive(item, capitalize=True), "Its fish"
         )
 
+        # Test for when user provides a pronoun string that cannot be parsed
+        # (doesn't follow the required 2-3 slash format), should fall back to using name's target
+        self.individual.pronouns = "custom"
+        self.individual.person_type = "individual"
+        self.individual.name.first = "John"
+        self.individual.name.last = "Smith"
+        # When pronouns can't be parsed, should use "{name}'s {target}"
+        self.assertEqual(self.individual.pronoun_possessive(item), "John Smith's fish")
+        self.assertEqual(
+            self.individual.pronoun_possessive(item, capitalize=True),
+            "John Smith's fish",
+        )
+
     def test_pronoun_subjective(self):
         self.individual.pronouns = None
         self.individual.person_type = "individual"

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassemble.AssemblyLine
-Version: 4.4.0
+Version: 4.5.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

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

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "docassemble.AssemblyLine"
-version = "4.4.0"
+version = "4.5.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 = [

{docassemble_assemblyline-4.4.0 → docassemble_assemblyline-4.5.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='4.4.0',
+      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',

docassemble_assemblyline-4.4.0/docassemble/AssemblyLine/__init__.py

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