Skip to main content

Suffolk LIT Lab Document Assembly Line

PyPI version

drawing

The Assembly Line Project is a collection of volunteers, students, and institutions who joined together during the COVID-19 pandemic to help increase access to the court system. Our vision is mobile-friendly, easy to use guided online forms that help empower litigants to access the court remotely.

Our signature project is CourtFormsOnline.org.

We designed a step-by-step, assembly line style process for automating court forms on top of Docassemble and built several tools along the way that you can use in your home jurisdiction.

This package contains runtime code and pre-written questions to support authoring robust, consistent, and attractive Docassemble interviews that help complete court forms.

Read more on our documentation page.

Related repositories

Documentation

https://suffolklitlab.org/docassemble-AssemblyLine-documentation/

Installation

Menu-driven installation

The recommended installation method is with the guided installation script.

Manual installation

Normally you do not need to manually install the Assembly Line. Use the installation script if you can. The instructions below are for your optional reference.

This package depends on the following configuration changes on your Docassemble server:

  • Ensure that font-awesome is enabled (this may be on by default:
default icons: font awesome
  • Add a Google API key that has access to:
    • Google Places API
    • Google Geocoding API
  • Add a VoiceRSS API key
  • Add a Twilio API key for SMS support
  • Add an email account: Mailgun or SendGrid recommended for email support
  • To show package update time and to enable the feedback form, add a GitHub Private Access token to your config.yml file, like this:
# Needs access to create new issues on repositories
github issues:
  username: "suffolklitlab-issues"
  token: "12345"
# Does not need any special access to public repositories  
github readonly:
  username: "suffolklitlab-issues"
  password: "45678"
  type: "basic"
install packages api key: 12345

Migration

See discussion here

ALDocument class

Purpose

The ALDocument class is a small utility library that makes it simpler to use the following features in an interview:

  • Conditional assembly of multiple, optional documents that are triggered in different ways in your interview
  • An addendum for PDF files that makes it simple to deal with overflow text
  • A customizable download screen that lists the documents in a neat table
  • A customizable "send" button that allows the user to email the final forms to a location of their choice

Here is a small snippet that you can copy and modify that shows how to use the most important features of the ALDocument class.

---
objects:
  - 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]")  
---
objects:
  - 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")
  - 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")
---
generic object: ALDocument
attachment:
  variable name: x.addendum
  docx template file: docx_addendum.docx
---
code: |
  CRA_Motion_to_Dismiss_attachment.overflow_fields['reasons_for_request'].overflow_trigger = 640
  CRA_Motion_to_Dismiss_attachment.overflow_fields['reasons_for_request'].label = "Reasons for request"
  CRA_Motion_to_Dismiss_attachment.overflow_fields.gathered = True
  
---
attachment:
    variable name: CRA_Motion_to_Dismiss_attachment[i]
    name: CRA Motion to Dismiss
    filename: CRA_Motion_to_Dismiss
    skip undefined: True
    pdf template file: CRA_Motion_to_Dismiss.pdf
    fields: 
      - "court_county": ${ trial_court.address.county }
      - "docket_number": ${ docket_number }
      - "user_signature": ${ users[0].signature_if_final(i) }
      - "signature_date": ${ signature_date }

It 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 some other method to "turn on" the attachment.

E.g.,

code: |
  CRA_Motion_to_Dismiss_attachment.enabled = condition1 and condition2

Changelog

See CHANGELOG.MD

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docassemble_assemblyline-4.6.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docassemble_assemblyline-4.6.3-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file docassemble_assemblyline-4.6.3.tar.gz.

File metadata

  • Download URL: docassemble_assemblyline-4.6.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for docassemble_assemblyline-4.6.3.tar.gz
Algorithm Hash digest
SHA256 5f40c19343e3a1e3cd29932326346236b9a9bf0b288b2398e80f3967cb98d6c0
MD5 74b2751a703f07a915adc37eb668acd5
BLAKE2b-256 9d95d8d00c36a7f2fb89e8a6a3168bbfd1bff9462331aa3b8773070ab70bdc0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for docassemble_assemblyline-4.6.3.tar.gz:

Publisher: publish.yml on SuffolkLITLab/docassemble-AssemblyLine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docassemble_assemblyline-4.6.3-py3-none-any.whl.

File metadata

File hashes

Hashes for docassemble_assemblyline-4.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b583f4de41fc2867a2bb337d17f9b6de5f9d1a9dd1ccda25eb3340e1b2e9381c
MD5 abf3fadd39a8033475bf81ee7c213af2
BLAKE2b-256 f1f5c63de6199908b56b744921d3bd88999527da3d666738f79fc72a46f031b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for docassemble_assemblyline-4.6.3-py3-none-any.whl:

Publisher: publish.yml on SuffolkLITLab/docassemble-AssemblyLine

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page