omnata-plugin-runtime 0.10.12__tar.gz → 0.11.7a324__tar.gz

{omnata_plugin_runtime-0.10.12 → omnata_plugin_runtime-0.11.7a324}/PKG-INFO

@@ -1,12 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: omnata-plugin-runtime
-Version: 0.10.12
+Version: 0.11.7a324
 Summary: Classes and common runtime components for building and running Omnata Plugins
+License-File: LICENSE
 Author: James Weakley
 Author-email: james.weakley@omnata.com
-Requires-Python: >=3.8,<=3.11
+Requires-Python: >=3.9,<=3.11
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11

{omnata_plugin_runtime-0.10.12 → omnata_plugin_runtime-0.11.7a324}/pyproject.toml

@@ -1,13 +1,13 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.10.12"
+version = "0.11.7-a324"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"
 packages = [{include = "omnata_plugin_runtime", from = "src"}]
 
 [tool.poetry.dependencies]
-python = ">=3.8, <=3.11"
+python = ">=3.9, <=3.11"
 snowflake-snowpark-python = ">=1.20.0,<=1.24.0" # latest version available on Snowflake Anaconda, but allow pinning to 1.20.0 for to_pandas_batches workaround
 snowflake-connector-python = "^3, <=3.12.0" # latest version available on Snowflake Anaconda
 cryptography = "<=43.0.0"

{omnata_plugin_runtime-0.10.12 → omnata_plugin_runtime-0.11.7a324}/src/omnata_plugin_runtime/api.py

@@ -108,9 +108,9 @@ class OutboundSyncRequestPayload(BaseModel):
     Encapsulates the payload that is sent to the plugin when it is invoked to perform an outbound sync.
     """
 
-    sync_id: int  # only used by log handler
+    sync_id: int
     sync_branch_name: str = 'main'
-    sync_branch_id: Optional[int]  # only used by log handler
+    sync_branch_id: Optional[int]
     connection_id: int  # only used by log handler
     run_id: int  # used by log handler and for reporting back run status updates
     source_app_name: str  # the name of the app which is invoking this plugin
@@ -139,8 +139,8 @@ class InboundSyncRequestPayload(BaseModel):
     Encapsulates the payload that is sent to the plugin when it is invoked to perform an inbound sync.
     """
 
-    sync_id: int  # only used by log handler
-    sync_branch_name: str = 'main' # only used by rate limit updater
+    sync_id: int
+    sync_branch_name: str = 'main'
     sync_branch_id: Optional[int] = None  # only used by log handler
     connection_id: int  # only used by log handler
     run_id: int  # used by log handler and for reporting back run status updates

{omnata_plugin_runtime-0.10.12 → omnata_plugin_runtime-0.11.7a324}/src/omnata_plugin_runtime/configuration.py

@@ -614,6 +614,10 @@ class StreamConfiguration(SubscriptableBaseModel):
         None,
         description="Marks the stream as requiring another stream to be selected"
     )
+    mandatory: bool = Field(
+        False,
+        description="Marks the stream as mandatory, meaning it cannot be excluded from the sync configuration"
+    )
 
 
 class StoredConfigurationValue(SubscriptableBaseModel):
@@ -923,7 +927,7 @@ class SyncScheduleDbt(SubscriptableBaseModel):
         time_limit_mins (int): The maximum time the sync can run for before being cancelled
         dbt_dev_target_name (str): The name of the dbt target used by developers outside of CI
         dbt_sync_model_name (str): The name of the dbt model used to run the sync
-        dbt_source_model_name (str): The name of the dbt model used as a source for the run. This will be resolved at runtime and replaces the configured source table
+        dbt_source_model_name (str): The name of the dbt model used as a source for the run, if the sync is Outbound. This will be resolved at runtime and replaces the configured source table
         is_dbt_cloud (bool): If true, dbt cloud is in use
     """
 
@@ -934,7 +938,7 @@ class SyncScheduleDbt(SubscriptableBaseModel):
     time_limit_mins: int = 60 * 4
     dbt_dev_target_name: str = "dev"
     dbt_sync_model_name: str
-    dbt_source_model_name: str
+    dbt_source_model_name: Optional[str] = Field(default=None)
     is_dbt_cloud: bool = True
 
 

{omnata_plugin_runtime-0.10.12 → omnata_plugin_runtime-0.11.7a324}/src/omnata_plugin_runtime/forms.py

@@ -222,6 +222,22 @@ class FormSliderField(SubscriptableBaseModel):
     step_size: int = Field(default=1)
 
 
+class FormSnowflakeStageField(SubscriptableBaseModel):
+    """
+    A field which represents a stage which can be selected from a list shared to the plugin.
+    """
+
+    name: str
+    label: str
+    default_value: Union[str, bool] = Field(default="")
+    required: bool = Field(default=False)
+    depends_on: Optional[str] = Field(default=None)
+    help_text: str = Field(default="")
+    reload_on_change: bool = Field(default=False)
+    secret: bool = Field(default=False)
+    type: Literal["snowflake_stage"] = "snowflake_stage"
+
+
 class FormJinjaTemplate(SubscriptableBaseModel):
     """
     Uses text area to allow the user to create a template, which can include column values from the source
@@ -340,7 +356,8 @@ FormFieldBase = Annotated[
         FormSliderField,
         FormDropdownField,
         InformationField,
-        InformationBoxField
+        InformationBoxField,
+        FormSnowflakeStageField
     ],
     Field(discriminator="type"),
 ]