Use Windmill Hub resource types, and document custom resource type usage

README.md

@@ -43,6 +43,12 @@ This repo also provides a shell script to batch push changes to a number of work
 
        (set -a; source .env; set +a; bin/push.sh)
 
+### Adding custom resource types
+
+At times, this repository may contain one or more [custom resource types](https://www.windmill.dev/docs/core_concepts/resources_and_types#create-a-resource-type) that are used by a number of the scripts in this repository. However, we commit to adding all of our resource types to [Windmill Hub](https://www.windmill.dev/docs/core_concepts/resources_and_types#sync-resource-types-with-windmillhub).
+
+There is no way to sync custom resource types to a Windmill workspace, so you will need to manually add them. The easiest way to do this is to paste them in to the JSON editor when creating a new resource type.
+
 ## Development
 
 In Windmill, scripts can be written in Python, TypeScript, Go, and a number of other languages. Flows and apps can 

f/connectors/alerts/alerts_twilio.py

@@ -3,11 +3,20 @@
 
 import json
 import logging
+from typing import TypedDict
 
 from twilio.rest import Client as TwilioClient
 
-# type names that refer to Windmill Resources
-c_twilio_message_template = dict
+
+# https://hub.windmill.dev/resource_types/274/twilio_message_template
+class twilio_message_template(TypedDict):
+    account_sid: str
+    auth_token: str
+    origin_number: str
+    recipients: list[str]
+    content_sid: str
+    messaging_service_sid: str
+
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
@@ -16,7 +25,7 @@
 def main(
     alerts_statistics: dict,
     community_slug: str,
-    twilio: c_twilio_message_template,
+    twilio: twilio_message_template,
 ):
     send_twilio_message(twilio, alerts_statistics, community_slug)
 

f/connectors/alerts/alerts_twilio.script.yaml

@@ -33,7 +33,7 @@ schema:
         ingesting and writing alerts to the database via a Twilio message
         content template.
       default: null
-      format: resource-c_twilio_message_template
+      format: resource-twilio_message_template
   required:
     - alerts_statistics
     - community_slug

f/connectors/arcgis/arcgis_feature_layer.py

@@ -5,22 +5,27 @@
 import logging
 import os
 from pathlib import Path
+from typing import TypedDict
 
 import requests
 
 from f.common_logic.db_operations import postgresql
 from f.common_logic.file_operations import save_data_to_file
 from f.connectors.geojson.geojson_to_postgres import main as save_geojson_to_postgres
 
-# type names that refer to Windmill Resources
-c_arcgis_account = dict
+
+# https://hub.windmill.dev/resource_types/271/arcgis_account
+class arcgis_account(TypedDict):
+    username: str
+    password: str
+
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
 
 def main(
-    arcgis_account: c_arcgis_account,
+    arcgis_account: arcgis_account,
     feature_layer_url: str,
     db: postgresql,
     db_table_name: str,
@@ -61,7 +66,7 @@ def main(
     )
 
 
-def get_arcgis_token(arcgis_account: c_arcgis_account):
+def get_arcgis_token(arcgis_account: arcgis_account):
     """
     Generate an ArcGIS token using the provided account credentials.
 

f/connectors/arcgis/arcgis_feature_layer.script.yaml

@@ -17,7 +17,7 @@ schema:
       type: object
       description: The name of the ArcGIS account to use for fetching the feature layer.
       default: null
-      format: resource-c_arcgis_account
+      format: resource-arcgis_account
       originalType: string
     attachment_root:
       type: string

f/connectors/comapeo/comapeo_alerts.py

@@ -13,6 +13,7 @@
 from f.common_logic.db_operations import conninfo, postgresql
 
 
+# https://hub.windmill.dev/resource_types/194/comapeo_server
 class comapeo_server(TypedDict):
     server_url: str
     access_token: str

f/connectors/globalforestwatch/gfw_alerts.py

@@ -6,22 +6,26 @@
 import logging
 import re
 from pathlib import Path
+from typing import TypedDict
 
 import requests
 
 from f.common_logic.db_operations import postgresql
 from f.common_logic.file_operations import save_data_to_file
 from f.connectors.geojson.geojson_to_postgres import main as save_geojson_to_postgres
 
-# type names that refer to Windmill Resources
-c_gfw_api = dict
+
+# https://hub.windmill.dev/resource_types/273/gfw_api
+class gfw_api(TypedDict):
+    api_key: str
+
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
 
 def main(
-    gfw_api: c_gfw_api,
+    gfw_api: gfw_api,
     bounding_box: str,
     type_of_alert: str,
     minimum_date: str,
@@ -57,7 +61,7 @@ def main(
 
 
 def fetch_alerts_from_gfw(
-    api_key: c_gfw_api, bounding_box: str, type_of_alert: str, minimum_date: str
+    api_key: gfw_api, bounding_box: str, type_of_alert: str, minimum_date: str
 ):
     """
     Get alerts from GFW API using the provided API key and bounding box.

f/connectors/globalforestwatch/gfw_alerts.script.yaml

@@ -37,7 +37,7 @@ schema:
         this year expires after 1 year. For now, you can obtain a new API key from 
         the Global Forest Watch API.
       default: null
-      format: resource-c_gfw_api
+      format: resource-gfw_api
     bounding_box:
       type: string
       description: >-

f/connectors/kobotoolbox/kobotoolbox_responses.py

@@ -7,21 +7,26 @@
 import json
 import logging
 from pathlib import Path
+from typing import TypedDict
 
 import requests
 
 from f.common_logic.db_operations import StructuredDBWriter, conninfo, postgresql
 from f.common_logic.file_operations import save_data_to_file
 
-# type names that refer to Windmill Resources
-c_kobotoolbox_account = dict
+
+# https://hub.windmill.dev/resource_types/193/kobotoolbox_account
+class kobotoolbox_account(TypedDict):
+    server_url: str
+    api_key: str
+
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger(__name__)
 
 
 def main(
-    kobotoolbox: c_kobotoolbox_account,
+    kobotoolbox: kobotoolbox_account,
     form_id: str,
     db: postgresql,
     db_table_name: str,

f/connectors/kobotoolbox/kobotoolbox_responses.script.yaml

@@ -41,7 +41,7 @@ schema:
       type: object
       description: A server and API key pair to connect to the KoboToolbox account
       default: null
-      format: resource-c_kobotoolbox_account
+      format: resource-kobotoolbox_account
       originalType: string
   required:
     - kobotoolbox