Merge branch 'main' into tooling_updates

Author: bmos

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## What is this change?
+- (List out the changes.)
+- (Link to any relevant Github issues or Slack discussion)
+
+## Considerations for discussion
+- (List out any significant design decisions that were made and why.)
+
+## How to test the changes (if needed)
+- (How should a reviewer test this functionality)

.github/workflows/dependency-review.yml

@@ -22,4 +22,4 @@ jobs:
 
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
 
-      - uses: actions/dependency-review-action@ce3cf9537a52e8119d91fd484ab5b8a807627bf8
+      - uses: actions/dependency-review-action@da24556b548a50705dd671f47852072ea4c105d9

.github/workflows/security_scorecard.yml

@@ -60,6 +60,6 @@ jobs:
           results_format: sarif
           publish_results: true
 
-      - uses: github/codeql-action/upload-sarif@60168efe1c415ce0f5521ea06d5c2062adbeed1b
+      - uses: github/codeql-action/upload-sarif@ff0a06e83cb2de871e5a09832bc6a81e7276941f
         with:
           sarif_file: results.sarif

docs/conf.py

@@ -47,6 +47,7 @@
     "sphinx.ext.viewcode",
     "myst_parser",
     "sphinx_multiversion",
+    "sphinxcontrib.googleanalytics",
 ]
 
 # Sorting of attributes
@@ -191,3 +192,6 @@
 
 # Get tags to whitelist from DOCUMENTED_VERSIONS const
 smv_tag_whitelist = "|".join(["^" + version + "$" for version in DOCUMENTED_VERSIONS])
+
+# Adds Google Analytics tracking code to the HTML output
+googleanalytics_id = "G-L2YB7WHTRG"

parsons/etl/etl.py

@@ -207,7 +207,7 @@ def convert_column(self, *column, **kwargs):
         """
         Transform values under one or more fields via arbitrary functions, method
         invocations or dictionary translations. This leverages the petl ``convert()``
-        method. Example usage can be found `here <https://petl.readthedocs.io/en/v0.24/transform.html#petl.convert>`_.
+        method. Example usage can be found `here <https://petl.readthedocs.io/latest/transform.html#petl.transform.conversions.convert>`_.
 
         `Args:`
             *column: str

parsons/newmode/newmode.py

@@ -427,11 +427,11 @@ def converted_request(
             client=client,
             override_api_version=override_api_version,
         )
-
-        if convert_to_table:
-            return client.convert_to_table(data=response)
-        else:
-            return response
+        if response:
+            if convert_to_table:
+                return client.convert_to_table(data=response)
+            else:
+                return response
 
     def get_campaign(self, campaign_id, params={}):
         """

parsons/ngpvan/contact_notes.py

@@ -27,7 +27,17 @@ def get_contact_notes(self, van_id):
         logger.info(f"Found {tbl.num_rows} custom fields.")
         return tbl
 
-    def create_contact_note(self, van_id, text, is_view_restricted, note_category_id=None):
+    def create_contact_note(
+        self,
+        van_id,
+        text,
+        is_view_restricted,
+        note_category_id=None,
+        contact_type_id=None,
+        input_type_id=None,
+        date_canvassed=None,
+        result_code_id=None,
+    ):
         """
         Create a contact note
 
@@ -42,6 +52,15 @@ def create_contact_note(self, van_id, text, is_view_restricted, note_category_id
                 in the current context.
             note_category_id: int
                 Optional; if set, the note category for this note.
+            contact_type_id: str
+                Defaults to 82 if no value is set. This value results in a null contact type in EA.
+            input_type_id: str
+                Defaults to 11 if no value is set. If the value is 11,
+                the input type in EA will be listed as "API"
+            date_canvassed: date
+                Defaults to current date if no value is set. Dates should be formatted in ISO8601 standard.
+            result_code_id: str
+                Defaults to 205 if no value is set. This value results in a "Contacted" result in EA.
         `Returns:`
             int
               The note ID.
@@ -50,6 +69,20 @@ def create_contact_note(self, van_id, text, is_view_restricted, note_category_id
         if note_category_id is not None:
             note["category"] = {"noteCategoryId": note_category_id}
 
+        contact_history = {}
+
+        if contact_type_id is not None:
+            contact_history["contact_type_id"] = str(contact_type_id)
+        if input_type_id is not None:
+            contact_history["input_type_id"] = str(input_type_id)
+        if date_canvassed is not None:
+            contact_history["dateCanvassed"] = date_canvassed
+        if result_code_id is not None:
+            contact_history["result_code_id"] = str(result_code_id)
+
+        if contact_history:
+            note["contactHistory"] = contact_history
+
         r = self.connection.post_request(f"people/{van_id}/notes", json=note)
         logger.info(f"Contact note {r} created.")
         return r

parsons/redash/redash.py

@@ -45,8 +45,8 @@ def __init__(
     ):
         self.base_url = check("REDASH_BASE_URL", base_url)
         self.user_api_key = check("REDASH_USER_API_KEY", user_api_key, optional=True)
-        self.pause = int(check("REDASH_PAUSE_TIME", pause_time, optional=True))
-        self.timeout = int(check("REDASH_TIMEOUT", timeout, optional=True))
+        self.pause = int(check("REDASH_PAUSE_TIME", str(pause_time), optional=True))
+        self.timeout = int(check("REDASH_TIMEOUT", str(timeout), optional=True))
 
         self.verify = verify  # for https requests
         self.session = requests.Session()

parsons/utilities/check_env.py

@@ -1,19 +1,20 @@
 import os
-from typing import NoReturn, Optional, Union
+from typing import Optional
 
 
-def check(env: str, field: Optional[str], optional: Optional[bool] = False) -> Union[str, NoReturn]:
+def check(env: str, field: Optional[str], optional: Optional[bool] = False) -> Optional[str]:
     """
     Check if an environment variable has been set. If it has not been set
     and the passed field or arguments have not been passed, then raise an
     error.
     """
-    if not field:
-        try:
-            return os.environ[env]
-        except KeyError:
-            if not optional:
-                raise KeyError(
-                    f"No {env} found. Store as environment variable or pass as an argument."
-                )
-    return field
+    if field:
+        return field
+    try:
+        return os.environ[env]
+    except KeyError as e:
+        if not optional:
+            raise KeyError(
+                f"No {env} found. Store as environment variable or pass as an argument."
+            ) from e
+        return None

requirements-dev.txt

@@ -2,7 +2,7 @@
 bandit[sarif]==1.8.3
 coverage==7.8.0
 pre-commit==4.2.0
-pytest-cov==6.0.0
+pytest-cov==6.1.1
 pytest-datadir==1.6.1
 pytest-mock==3.14.0
 pytest-xdist==3.6.1
@@ -14,6 +14,7 @@ testfixtures==8.3.0
 # Docs Requirements
 myst-parser==3.0.1;python_version<'3.10'
 myst-parser==4.0.1;python_version>='3.10'
+sphinxcontrib-googleanalytics
 sphinx-multiversion
 sphinx-rtd-theme==3.0.2
 Sphinx==7.4.7;python_version<'3.10'