Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suffolklitlab/docassemble-assemblyline
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.
https://github.com/suffolklitlab/docassemble-assemblyline
access-to-justice courts docassemble form-builder
Last synced: 4 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/suffolklitlab/docassemble-assemblyline
- Owner: SuffolkLITLab
- License: mit
- Created: 2020-12-22T16:33:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T16:35:37.000Z (6 months ago)
- Last Synced: 2024-05-22T16:36:05.559Z (6 months ago)
- Topics: access-to-justice, courts, docassemble, form-builder
- Language: Python
- Homepage: https://suffolklitlab.org/docassemble-AssemblyLine-documentation/
- Size: 2.23 MB
- Stars: 37
- Watchers: 7
- Forks: 5
- Open Issues: 104
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Suffolk LIT Lab Document Assembly Line
[](https://badge.fury.io/py/docassemble-AssemblyLine)
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](https://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](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/).
# Related repositories
* https://github.com/SuffolkLitLab/docassemble-ALWeaver
* https://github.com/SuffolkLitLab/docassemble-ALMassachusetts
* https://github.com/SuffolkLitLab/docassemble-MassAccess
* https://github.com/SuffolkLitLab/docassemble-ALThemeTemplate
* https://github.com/SuffolkLitLab/EfileProxyServer
# Documentation
https://suffolklitlab.org/docassemble-AssemblyLine-documentation/
# Installation
## Menu-driven installation
The recommended installation method is with the [guided installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation).
## Manual installation
Normally you do not need to manually install the Assembly Line. Use the [installation script](https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/installation)
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](https://docassemble.org/docs/config.html#default%20icons) is enabled (this may be on by default:
```yaml
default icons: font awesome
```
* Add a [Google API key](https://docassemble.org/docs/config.html#google) that has access to:
* Google Places API
* Google Geocoding API
* Add a [VoiceRSS API key](https://docassemble.org/docs/config.html#voicerss)
* Add a [Twilio API key](https://docassemble.org/docs/config.html#twilio) for SMS support
* 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
* To show package update time and to enable the feedback form, add a GitHub Private Access token to your config.yml file, like this:
```yaml
# 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"
```
* 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:
```yaml
install packages api key: 12345
```
# Migration
See [discussion here](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/issues/69)
# 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](https://github.com/SuffolkLITLab/docassemble-AssemblyLine/blob/main/CHANGELOG.md)