Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ jobs:
pydoc-markdown
./make_interview_docs.py ../docassemble-ALDashboard
./fix-doc-titles.sh
./fix-doc-anchors.py
- uses: actions/setup-node@v3
with:
node-version: 20
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ jobs:
pydoc-markdown
./make_interview_docs.py ../docassemble-ALDashboard
./fix-doc-titles.sh
./fix-doc-anchors.py
- uses: actions/setup-node@v3
with:
node-version: 20
Expand Down
2 changes: 1 addition & 1 deletion docs/authoring/writing_review_screen.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This page is a step-by-step tutorial on how to write a review screen, and covers
- [Step 1: AL Review Generator](#step-1-al-review-generator)
- [Step 2: Understanding and Editing the Generated Review Screen](#step-2-understanding-and-editing-the-generated-review-screen)
- [Edits to the Review Screen](#edits-to-the-review-screen)
- [Step 4: Things to add to the review screen](#step-4-things-to-add-to-the-review-screen)
- [Step 3: Things to add to the review screen](#step-3-things-to-add-to-the-review-screen)

## Why make a review screen?

Expand Down
50 changes: 13 additions & 37 deletions docs/components/ALDashboard/aldashboard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Table of Contents

* [ALDashboard.aldashboard](#ALDashboard.aldashboard)
* ALDashboard.aldashboard
* [speedy\_get\_users](#ALDashboard.aldashboard.speedy_get_users)
* [speedy\_get\_sessions](#ALDashboard.aldashboard.speedy_get_sessions)
* [dashboard\_get\_session\_variables](#ALDashboard.aldashboard.dashboard_get_session_variables)
Expand All @@ -19,19 +19,15 @@ sidebar_label: aldashboard
title: ALDashboard.aldashboard
---

<a id="ALDashboard.aldashboard.speedy_get_users"></a>

#### speedy\_get\_users()
#### speedy\_get\_users() {#ALDashboard.aldashboard.speedy\_get\_users}

```python
def speedy_get_users() -> List[Dict[int, str]]
```

Return a list of all users in the database. Possibly faster than get_user_list().

<a id="ALDashboard.aldashboard.speedy_get_sessions"></a>

#### speedy\_get\_sessions(user\_id: Optional[int] = None, filename: Optional[str] = None, filter\_step1: bool = True, metadata\_key\_name: str = "metadata")
#### speedy\_get\_sessions(user\_id: Optional[int] = None, filename: Optional[str] = None, filter\_step1: bool = True, metadata\_key\_name: str = "metadata") {#ALDashboard.aldashboard.speedy\_get\_sessions}

```python
def speedy_get_sessions(user_id: Optional[int] = None,
Expand All @@ -48,29 +44,23 @@ user_id,
modtime,
key

<a id="ALDashboard.aldashboard.dashboard_get_session_variables"></a>

#### dashboard\_get\_session\_variables(session\_id: str, filename: str)
#### dashboard\_get\_session\_variables(session\_id: str, filename: str) {#ALDashboard.aldashboard.dashboard\_get\_session\_variables}

```python
def dashboard_get_session_variables(session_id: str, filename: str)
```

Return the variables and steps for a given session ID and YAML filename in serializable dictionary format.

<a id="ALDashboard.aldashboard.ALPackageInstaller"></a>

## ALPackageInstaller Objects
## ALPackageInstaller Objects {#ALDashboard.aldashboard.ALPackageInstaller}

```python
class ALPackageInstaller(DAObject)
```

Methods and state for installing AssemblyLine.

<a id="ALDashboard.aldashboard.ALPackageInstaller.get_validated_github_username"></a>

#### get\_validated\_github\_username(access\_token: str)
#### get\_validated\_github\_username(access\_token: str) {#ALDashboard.aldashboard.ALPackageInstaller.get\_validated\_github\_username}

```python
def get_validated_github_username(access_token: str)
Expand All @@ -79,19 +69,15 @@ def get_validated_github_username(access_token: str)
Given a valid GitHub `access_token`, returns the username associated with it.
Otherwise, adds one or more errors to the installer.

<a id="ALDashboard.aldashboard.ErrorList"></a>

## ErrorList Objects
## ErrorList Objects {#ALDashboard.aldashboard.ErrorList}

```python
class ErrorList(DAList)
```

Contains `ErrorLikeObject`s so they can be recognized by docassemble.

<a id="ALDashboard.aldashboard.ErrorLikeObject"></a>

## ErrorLikeObject Objects
## ErrorLikeObject Objects {#ALDashboard.aldashboard.ErrorLikeObject}

```python
class ErrorLikeObject(DAObject)
Expand All @@ -101,29 +87,23 @@ An object with a `template_name` that identifies the DALazyTemplate that will
show its error. It can contain any other attributes so its template can access them
as needed. DAObject doesn&#x27;t seem to be enough to allow template definition.

<a id="ALDashboard.aldashboard.install_fonts"></a>

#### install\_fonts(the\_font\_files: DAFileList)
#### install\_fonts(the\_font\_files: DAFileList) {#ALDashboard.aldashboard.install\_fonts}

```python
def install_fonts(the_font_files: DAFileList)
```

Install fonts to the server and restart both supervisor and unoconv.

<a id="ALDashboard.aldashboard.list_installed_fonts"></a>

#### list\_installed\_fonts()
#### list\_installed\_fonts() {#ALDashboard.aldashboard.list\_installed\_fonts}

```python
def list_installed_fonts()
```

List the fonts installed on the server.

<a id="ALDashboard.aldashboard.nicer_interview_filename"></a>

#### nicer\_interview\_filename(filename: str)
#### nicer\_interview\_filename(filename: str) {#ALDashboard.aldashboard.nicer\_interview\_filename}

```python
def nicer_interview_filename(filename: str) -> str
Expand All @@ -132,9 +112,7 @@ def nicer_interview_filename(filename: str) -> str
Given a filename like docassemble.playground10ALWeaver:data/questions/assembly_line.yml,
return a less cluttered name like: playground10ALWeaver:assembly_line

<a id="ALDashboard.aldashboard.list_question_files_in_package"></a>

#### list\_question\_files\_in\_package(package\_name: str)
#### list\_question\_files\_in\_package(package\_name: str) {#ALDashboard.aldashboard.list\_question\_files\_in\_package}

```python
def list_question_files_in_package(package_name: str) -> Optional[List[str]]
Expand All @@ -151,9 +129,7 @@ List all the files in the &#x27;data/questions&#x27; directory of a package.

- `List[str]` - A list of filenames in the &#x27;data/questions&#x27; directory of the package.

<a id="ALDashboard.aldashboard.list_question_files_in_docassemble_packages"></a>

#### list\_question\_files\_in\_docassemble\_packages()
#### list\_question\_files\_in\_docassemble\_packages() {#ALDashboard.aldashboard.list\_question\_files\_in\_docassemble\_packages}

```python
def list_question_files_in_docassemble_packages()
Expand Down
6 changes: 2 additions & 4 deletions docs/components/ALDashboard/create_package.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# Table of Contents

* [ALDashboard.create\_package](#ALDashboard.create_package)
* ALDashboard.create\_package
* [create\_package\_zip](#ALDashboard.create_package.create_package_zip)

---
sidebar_label: create_package
title: ALDashboard.create_package
---

<a id="ALDashboard.create_package.create_package_zip"></a>

#### create\_package\_zip(pkgname: str, info: dict, author\_info: dict, folders\_and\_files: dict, fileobj: Optional[DAFile] = None)
#### create\_package\_zip(pkgname: str, info: dict, author\_info: dict, folders\_and\_files: dict, fileobj: Optional[DAFile] = None) {#ALDashboard.create\_package.create\_package\_zip}

```python
def create_package_zip(pkgname: str,
Expand Down
14 changes: 4 additions & 10 deletions docs/components/ALDashboard/docx_wrangling.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Table of Contents

* [ALDashboard.docx\_wrangling](#ALDashboard.docx_wrangling)
* ALDashboard.docx\_wrangling
* [update\_docx](#ALDashboard.docx_wrangling.update_docx)
* [get\_labeled\_docx\_runs](#ALDashboard.docx_wrangling.get_labeled_docx_runs)
* [modify\_docx\_with\_openai\_guesses](#ALDashboard.docx_wrangling.modify_docx_with_openai_guesses)
Expand All @@ -10,9 +10,7 @@ sidebar_label: docx_wrangling
title: ALDashboard.docx_wrangling
---

<a id="ALDashboard.docx_wrangling.update_docx"></a>

#### update\_docx(document: Union[docx.document.Document, str], modified\_runs: List[Tuple[int, int, str, int]])
#### update\_docx(document: Union[docx.document.Document, str], modified\_runs: List[Tuple[int, int, str, int]]) {#ALDashboard.docx\_wrangling.update\_docx}

```python
def update_docx(
Expand All @@ -35,9 +33,7 @@ Update the document with modified runs.

The modified document.

<a id="ALDashboard.docx_wrangling.get_labeled_docx_runs"></a>

#### get\_labeled\_docx\_runs(docx\_path: str, custom\_people\_names: Optional[Tuple[str, str]] = None, openai\_client: Optional[OpenAI] = None)
#### get\_labeled\_docx\_runs(docx\_path: str, custom\_people\_names: Optional[Tuple[str, str]] = None, openai\_client: Optional[OpenAI] = None) {#ALDashboard.docx\_wrangling.get\_labeled\_docx\_runs}

```python
def get_labeled_docx_runs(
Expand All @@ -59,9 +55,7 @@ Scan the DOCX and return a list of modified text with Jinja2 variable names inse

A list of tuples, each containing a paragraph number, run number, and the modified text of the run.

<a id="ALDashboard.docx_wrangling.modify_docx_with_openai_guesses"></a>

#### modify\_docx\_with\_openai\_guesses(docx\_path: str)
#### modify\_docx\_with\_openai\_guesses(docx\_path: str) {#ALDashboard.docx\_wrangling.modify\_docx\_with\_openai\_guesses}

```python
def modify_docx_with_openai_guesses(docx_path: str) -> docx.document.Document
Expand Down
22 changes: 6 additions & 16 deletions docs/components/ALDashboard/package_scanner.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Table of Contents

* [ALDashboard.package\_scanner](#ALDashboard.package_scanner)
* ALDashboard.package\_scanner
* [URL](#ALDashboard.package_scanner.URL)
* [PARAMETERS](#ALDashboard.package_scanner.PARAMETERS)
* [DELAY\_BETWEEN\_QUERYS](#ALDashboard.package_scanner.DELAY_BETWEEN_QUERYS)
Expand All @@ -12,37 +12,27 @@ sidebar_label: package_scanner
title: ALDashboard.package_scanner
---

<a id="ALDashboard.package_scanner.URL"></a>

#### URL
#### URL {#ALDashboard.package\_scanner.URL}

The basic URL to use the GitHub API

<a id="ALDashboard.package_scanner.PARAMETERS"></a>

#### PARAMETERS
#### PARAMETERS {#ALDashboard.package\_scanner.PARAMETERS}

Additional parameters for the query (by default 100 items per page)

<a id="ALDashboard.package_scanner.DELAY_BETWEEN_QUERYS"></a>

#### DELAY\_BETWEEN\_QUERYS
#### DELAY\_BETWEEN\_QUERYS {#ALDashboard.package\_scanner.DELAY\_BETWEEN\_QUERYS}

The time to wait between different queries to GitHub

<a id="ALDashboard.package_scanner.getUrl"></a>

#### getUrl(url)
#### getUrl(url) {#ALDashboard.package\_scanner.getUrl}

```python
def getUrl(url)
```

Given a URL it returns its body

<a id="ALDashboard.package_scanner.fetch_github_repos"></a>

#### fetch\_github\_repos(github\_user, sub\_queries)
#### fetch\_github\_repos(github\_user, sub\_queries) {#ALDashboard.package\_scanner.fetch\_github\_repos}

```python
def fetch_github_repos(github_user, sub_queries) -> dict
Expand Down
42 changes: 11 additions & 31 deletions docs/components/ALDashboard/project_maintenance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Table of Contents

* [ALDashboard.project\_maintenance](#ALDashboard.project_maintenance)
* ALDashboard.project\_maintenance
* [get\_package\_names](#ALDashboard.project_maintenance.get_package_names)
* [add\_tag\_to\_repos](#ALDashboard.project_maintenance.add_tag_to_repos)
* [process\_packages\_and\_add\_tag](#ALDashboard.project_maintenance.process_packages_and_add_tag)
Expand All @@ -17,9 +17,7 @@ sidebar_label: project_maintenance
title: ALDashboard.project_maintenance
---

<a id="ALDashboard.project_maintenance.get_package_names"></a>

#### get\_package\_names(server\_name: str)
#### get\_package\_names(server\_name: str) {#ALDashboard.project\_maintenance.get\_package\_names}

```python
def get_package_names(server_name: str) -> List[str]
Expand All @@ -36,9 +34,7 @@ Fetches the JSON file from the given docassemble server and extracts package nam

- `List[str]` - List of package names.

<a id="ALDashboard.project_maintenance.add_tag_to_repos"></a>

#### add\_tag\_to\_repos(token: str, org\_name: str, repo\_names: List[str], tag: str)
#### add\_tag\_to\_repos(token: str, org\_name: str, repo\_names: List[str], tag: str) {#ALDashboard.project\_maintenance.add\_tag\_to\_repos}

```python
def add_tag_to_repos(token: str, org_name: str, repo_names: List[str],
Expand Down Expand Up @@ -67,9 +63,7 @@ Adds a specific tag to each repository in the given list.

add_tag_to_repos(personal_access_token, organization_name, repositories, tag_to_add)

<a id="ALDashboard.project_maintenance.process_packages_and_add_tag"></a>

#### process\_packages\_and\_add\_tag(server\_name: str, token: str, org\_name: str, tag: str)
#### process\_packages\_and\_add\_tag(server\_name: str, token: str, org\_name: str, tag: str) {#ALDashboard.project\_maintenance.process\_packages\_and\_add\_tag}

```python
def process_packages_and_add_tag(server_name: str, token: str, org_name: str,
Expand All @@ -86,9 +80,7 @@ and adds a specified tag to each repository.
- `org_name` _str_ - Name of the GitHub organization.
- `tag` _str_ - Tag to be added to each repository.

<a id="ALDashboard.project_maintenance.get_project_by_name"></a>

#### get\_project\_by\_name(token: str, org\_name: str, project\_name: str)
#### get\_project\_by\_name(token: str, org\_name: str, project\_name: str) {#ALDashboard.project\_maintenance.get\_project\_by\_name}

```python
def get_project_by_name(token: str, org_name: str,
Expand All @@ -108,9 +100,7 @@ Finds a GitHub Next-Generation project by its name within an organization using

- `dict` - The GitHub project object, or None if not found.

<a id="ALDashboard.project_maintenance.get_repos_by_topic"></a>

#### get\_repos\_by\_topic(token: str, org\_name: str, topic: str)
#### get\_repos\_by\_topic(token: str, org\_name: str, topic: str) {#ALDashboard.project\_maintenance.get\_repos\_by\_topic}

```python
def get_repos_by_topic(token: str, org_name: str,
Expand All @@ -130,9 +120,7 @@ Fetches repositories in an organization that have a specific topic.

- `List[Repository]` - A list of repository objects that have the specified topic.

<a id="ALDashboard.project_maintenance.add_issues_and_create_cards"></a>

#### add\_issues\_and\_create\_cards(token: str, org\_name: str, project\_name: str, topic: str, issue\_title: str, issue\_body: str)
#### add\_issues\_and\_create\_cards(token: str, org\_name: str, project\_name: str, topic: str, issue\_title: str, issue\_body: str) {#ALDashboard.project\_maintenance.add\_issues\_and\_create\_cards}

```python
def add_issues_and_create_cards(token: str, org_name: str, project_name: str,
Expand All @@ -151,9 +139,7 @@ Adds an issue to each repository with a specific topic and creates a card for ea
- `issue_title` _str_ - Title of the issue.
- `issue_body` _str_ - Body of the issue.

<a id="ALDashboard.project_maintenance.find_issues_by_title"></a>

#### find\_issues\_by\_title(token: str, org\_name: str, repo\_names: List[str], issue\_title: str)
#### find\_issues\_by\_title(token: str, org\_name: str, repo\_names: List[str], issue\_title: str) {#ALDashboard.project\_maintenance.find\_issues\_by\_title}

```python
def find_issues_by_title(token: str, org_name: str, repo_names: List[str],
Expand All @@ -174,9 +160,7 @@ Finds issues in a list of repositories with a specific title.

- `list` - A list of issue node IDs.

<a id="ALDashboard.project_maintenance.add_issue_to_project"></a>

#### add\_issue\_to\_project(token: str, project\_id: str, issue\_node\_id: str)
#### add\_issue\_to\_project(token: str, project\_id: str, issue\_node\_id: str) {#ALDashboard.project\_maintenance.add\_issue\_to\_project}

```python
def add_issue_to_project(token: str, project_id: str,
Expand All @@ -191,9 +175,7 @@ Adds an issue to a Next-Generation GitHub project.
- `project_id` _str_ - Node ID of the GitHub project.
- `issue_node_id` _str_ - Node ID of the GitHub issue.

<a id="ALDashboard.project_maintenance.link_issue_title_to_project"></a>

#### link\_issue\_title\_to\_project(token: str, org\_name: str, project\_name: str, topic: str, issue\_title: str)
#### link\_issue\_title\_to\_project(token: str, org\_name: str, project\_name: str, topic: str, issue\_title: str) {#ALDashboard.project\_maintenance.link\_issue\_title\_to\_project}

```python
def link_issue_title_to_project(token: str, org_name: str, project_name: str,
Expand All @@ -210,9 +192,7 @@ Links issues with a specific title in repositories with a certain topic to a Nex
- `topic` _str_ - The GitHub topic to filter repositories by.
- `issue_title` _str_ - Title of the issue to link.

<a id="ALDashboard.project_maintenance.main"></a>

#### main()
#### main() {#ALDashboard.project\_maintenance.main}

```python
def main() -> None
Expand Down
Loading
Loading