omnata-plugin-runtime 0.1.0__py3-none-any.whl

omnata_plugin_runtime/__init__.py

@@ -0,0 +1,39 @@
+r"""
+# Omnata Plugin Runtime
+
+This runtime provides a Python-based plugin system for Omnata.
+
+The runtime is kept separate from the Devkit in order to keep runtime dependencies to a minimum.
+
+It contains several submodules:
+
+## api
+
+Used internally for the interface between the plugin and the Omnata engine. Not intended for use by plugin developers.
+
+## configuration
+
+Data classes used by the configuration process
+
+## forms
+
+Containers for form elements, used by the Omnata UI to render configuration forms during connection and sync setup.
+
+## omnata_plugin
+
+The main plugin engine, contains the OmnataPlugin class which is subclassed when creating a plugin, as well as
+related classes for handling requests and responses.
+
+## rate_limiting
+
+Functionality for rate limiting API calls to remote systems.
+
+## record_transformer
+
+Record transformation functionality. Source records are transformed during each sync run in order to check for differences.
+This is a lightweight operation achieved via User-Defined-Functions, so record transformers are kept separate from the
+plugin code to further minimise dependancies.
+
+"""
+
+__docformat__ = "markdown"  # explicitly disable rST processing in the examples above.

omnata_plugin_runtime/api.py

@@ -0,0 +1,73 @@
+import sys
+if tuple(sys.version_info[:2]) >= (3, 9):
+    # Python 3.9 and above
+    from typing import Annotated
+else:
+    # Python 3.8 and below
+    from typing_extensions import Annotated
+
+from pydantic import BaseModel,Field # pylint: disable=no-name-in-module
+from typing import Optional, Dict, List, Literal, Union
+from .rate_limiting import ApiLimits, RateLimitState
+from .configuration import InboundSyncStreamsConfiguration, OutboundSyncStrategy, StoredConfigurationValue, StoredFieldMappings
+from .omnata_plugin import PluginManifest
+
+class OutboundApplyPayload(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_branch_id:Optional[int] # 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
+    source_app_name:str # the name of the app which is invoking this plugin
+    results_schema_name:str # the name of the schema where the results table resides
+    results_table_name:str # used to stage results back to the engine, resides in the main Omnata app database
+    logging_level:str
+    connection_method:str
+    connection_parameters:Dict[str,StoredConfigurationValue]
+    oauth_secret_name:Optional[str]
+    other_secrets_name:Optional[str]
+    sync_direction:Literal["outbound"] = 'outbound'
+    sync_strategy:OutboundSyncStrategy
+    sync_parameters:Dict[str,StoredConfigurationValue]
+    api_limit_overrides:List[ApiLimits]
+    rate_limits_state:Dict[str, RateLimitState]
+    field_mappings:StoredFieldMappings
+
+class InboundApplyPayload(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_id:Optional[int] # 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
+    source_app_name:str # the name of the app which is invoking this plugin
+    results_schema_name:str # the name of the schema where the results table resides
+    results_table_name:str # used to stage results back to the engine, resides in the main Omnata app database
+    logging_level:str
+    connection_method:str
+    connection_parameters:Dict[str,StoredConfigurationValue]
+    oauth_secret_name:Optional[str]
+    other_secrets_name:Optional[str]
+    sync_direction:Literal["inbound"] = 'inbound'
+    sync_parameters:Dict[str,StoredConfigurationValue]
+    api_limit_overrides:List[ApiLimits]
+    rate_limits_state:Dict[str, RateLimitState]
+    streams_configuration:InboundSyncStreamsConfiguration
+    latest_stream_state:Dict
+
+ApplyPayload = Annotated[Union[OutboundApplyPayload,InboundApplyPayload],Field(discriminator='sync_direction')]
+
+class PluginInfo(BaseModel):
+    """
+    Manifest plus other derived information about a plugin which is determined during upload.
+    """
+    manifest: PluginManifest
+    anaconda_packages:List[str]
+    bundled_packages:List[str]
+    icon_source: Optional[str]
+    plugin_class_name: str
+    transformer_class_name: Optional[str]
+    package_source: Literal['function','stage']