another-ayx-python-sdk 2.4.2__py3-none-any.whl

another_ayx_python_sdk/examples/AyxSdkMultiConnectionsMultiOutputAnchor/main.py

@@ -0,0 +1,102 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Example multiple input connection anchor tool."""
+from typing import Dict, TYPE_CHECKING
+
+from another_ayx_python_sdk.core import PluginV2
+
+
+if TYPE_CHECKING:
+    import pyarrow as pa
+    from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+    from another_ayx_python_sdk.core.constants import Anchor
+
+
+class AyxSdkMultiConnectionsMultiOutputAnchor(PluginV2):
+    """Concrete implementation of an AyxPlugin."""
+
+    def __init__(self, provider: "AMPProviderV2") -> None:
+        """Construct a plugin."""
+        self.provider = provider
+        self.provider.io.info("Plugin initialized.")
+        try:
+            self.conn_to_output = self.get_conn_map()
+        except Exception as e:
+            self.provider.io.error(f"Failed to set conn map {repr(e)}")
+
+    def get_conn_map(self) -> Dict[str, str]:
+        """Map the connections of Input anchor to Output anchors."""
+        connections = self.provider.incoming_anchors["Input"].keys()
+        conn_to_output = {}
+        for name in connections:
+            conn_num = int(name.strip("#"))
+            if conn_num >= 5:
+                # Add any additional input to the last existing anchor.
+                conn_to_output[name] = f"Output5"
+            else:
+                conn_to_output[name] = f"Output{conn_num}"
+        return conn_to_output
+
+    def on_incoming_connection_complete(self, anchor: "Anchor") -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection.
+        """
+        self.provider.io.info(
+            f"Received complete update from {anchor.name}:{anchor.connection}."
+        )
+
+    def on_record_batch(self, table: "pa.Table", anchor: "Anchor") -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batch
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection']) containing input connection identifiers.
+        """
+        try:
+            out_anchor = self.conn_to_output[anchor.connection]
+            self.provider.write_to_anchor(out_anchor, table)
+        except Exception as e:
+            self.provider.io.warn(
+                f"Failed to write batch to output anchor. \n{repr(e)}"
+            )
+
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        self.provider.io.info("AyxSdkMultiConnectionsMultiOutputAnchor tool done.")

another_ayx_python_sdk/examples/AyxSdkMultipleInputAnchors/AyxSdkMultipleInputAnchorsConfig.xml

@@ -0,0 +1,24 @@
+<AlteryxJavaScriptPlugin>
+  <EngineSettings EngineDll="Python" EngineDllEntryPoint="main.py" SDKVersion="10.1" ToolFamily="AyxPluginSdkExamples" />
+  <GuiSettings Html="index.html" Icon="icon.png" SDKVersion="10.1">
+    <InputConnections>
+      <Connection AllowMultiple="False" Label="" Name="Input1" Optional="False" Type="Connection" />
+      <Connection AllowMultiple="False" Label="" Name="Input2" Optional="False" Type="Connection" />
+    </InputConnections>
+    <OutputConnections>
+      <Connection AllowMultiple="False" Label="" Name="Output" Optional="False" Type="Connection" />
+    </OutputConnections>
+  </GuiSettings>
+  <Properties>
+    <MetaInfo>
+      <Name>AyxSdkMultipleInputAnchors</Name>
+      <Description>Example multiple input anchor tool.</Description>
+      <ToolVersion>1.0</ToolVersion>
+      <CategoryName>SDK Examples</CategoryName>
+      <SearchTags>python, sdk, python sdk</SearchTags>
+      <Author>Alteryx, Inc.</Author>
+      <Company>Alteryx, Inc.</Company>
+      <Copyright>2020</Copyright>
+    </MetaInfo>
+  </Properties>
+</AlteryxJavaScriptPlugin>

another_ayx_python_sdk/examples/AyxSdkMultipleInputAnchors/main.py

@@ -0,0 +1,84 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Example multiple input anchor tool."""
+from typing import TYPE_CHECKING
+
+from another_ayx_python_sdk.core import PluginV2
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+    import pyarrow as pa
+    from another_ayx_python_sdk.core.constants import Anchor
+
+
+class AyxSdkMultipleInputAnchors(PluginV2):
+    """Concrete implementation of an AyxPlugin."""
+
+    def __init__(self, provider: "AMPProviderV2") -> None:
+        """Construct a plugin."""
+        self.provider = provider
+        self.output_anchor_name = "Output"
+        self.provider.io.info("Plugin initialized.")
+
+    def on_incoming_connection_complete(self, anchor: "Anchor") -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection.
+        """
+        self.provider.io.info(
+            f"Received complete update from {anchor.name}:{anchor.connection}."
+        )
+
+    def on_record_batch(self, table: "pa.Table", anchor: "Anchor") -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batch
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection']) containing input connection identifiers.
+        """
+        try:
+            self.provider.write_to_anchor(self.output_anchor_name, table)
+        except Exception as e:
+            self.provider.io.warn(
+                f"Error Occured while writing to anchor {anchor.name} \n {repr(e)}"
+            )
+
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        self.provider.io.info("AyxSdkMultipleInputAnchors tool done.")

another_ayx_python_sdk/examples/AyxSdkMultipleOutputAnchors/main.py

@@ -0,0 +1,96 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Example pass through tool."""
+from another_ayx_python_sdk.core import (
+    Anchor,
+    PluginV2,
+)
+from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+
+from pandas.core.dtypes.common import is_integer_dtype
+
+from pyarrow import RecordBatch, Table
+
+
+class AyxSdkMultipleOutputAnchors(PluginV2):
+    """A sample Plugin that filters numeric data for odd and even values."""
+
+    def __init__(self, provider: "AMPProviderV2"):
+        """Construct the plugin."""
+        self.provider = provider
+        self.provider.io.info("AyxSdkMultipleOutputAnchors tool started.")
+
+    def on_record_batch(self, batch: "Table", anchor: "Anchor") -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batch
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection']) containing input connection identifiers.
+        """
+        metadata = batch.schema
+        if not any([field_name == "Value" for field_name in metadata.names]):
+            raise RuntimeError(
+                "Incoming data must contain a column with the name 'Value'"
+            )
+        input_dataframe = batch.to_pandas()
+
+        if not is_integer_dtype(input_dataframe["Value"]):
+            raise RuntimeError("'Value' column must be of 'int' data type")
+
+        grouped = input_dataframe.groupby("Value")
+        odds = grouped.filter(lambda row: (row["Value"] % 2 == 1).any())
+        evens = grouped.filter(lambda row: (row["Value"] % 2 == 0).any())
+
+        odd_batch = RecordBatch.from_pandas(odds, preserve_index=False)
+        even_batch = RecordBatch.from_pandas(evens, preserve_index=False)
+        self.provider.write_to_anchor("Output1", odd_batch)
+        self.provider.write_to_anchor("Output2", even_batch)
+
+    def on_incoming_connection_complete(self, anchor: "Anchor") -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection.
+        """
+        self.provider.io.info(
+            f"Received complete update from {anchor.name}:{anchor.connection}."
+        )
+
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        self.provider.io.info("AyxSdkMultipleOutputAnchors tool done.")

another_ayx_python_sdk/examples/AyxSdkOptionalInputAnchor/main.py

@@ -0,0 +1,94 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Example optional input anchor tool."""
+from typing import TYPE_CHECKING
+
+from another_ayx_python_sdk.core import PluginV2
+
+import pyarrow as pa
+
+if TYPE_CHECKING:
+    from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+    from another_ayx_python_sdk.core.constants import Anchor
+
+
+class AyxSdkOptionalInputAnchor(PluginV2):
+    """Concrete implementation of an AyxPlugin."""
+
+    def __init__(self, provider: "AMPProviderV2") -> None:
+        """Construct a plugin."""
+        self.provider = provider
+        self.config_value = 0.42
+        self.output_anchor = self.provider.outgoing_anchors["Output"]
+        self.input_anchor = self.provider.incoming_anchors["Input"]
+        self.provider.io.info("Plugin initialized.")
+
+    def on_incoming_connection_complete(self, anchor: "Anchor") -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection.
+        """
+        self.provider.io.info(
+            f"Received complete update from {anchor.name}:{anchor.connection}."
+        )
+
+    def on_record_batch(self, batch: "pa.Table", anchor: "Anchor") -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batch
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection']) containing input connection identifiers.
+        """
+        try:
+            self.provider.write_to_anchor("Output", batch)
+        except Exception as e:
+            self.provider.io.warn(
+                f"Error Occured while writing to anchor {anchor.name} \n {repr(e)}"
+            )
+
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        if len(self.input_anchor.keys()) == 0:
+            import pandas as pd
+
+            df = pd.DataFrame({"OptionalField": [self.config_value]})
+            batch_to_send = pa.RecordBatch.from_pandas(df=df, preserve_index=False)
+            self.provider.write_to_anchor("Output", batch_to_send)
+
+        self.provider.io.info("AyxSdkOptionalInputAnchor tool done.")

another_ayx_python_sdk/examples/AyxSdkOutput/main.py

@@ -0,0 +1,78 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Example output tool."""
+
+from another_ayx_python_sdk.core import (
+    Anchor,
+    PluginV2,
+)
+from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+
+import pyarrow as pa
+
+
+class AyxSdkOutput(PluginV2):
+    """A sample Plugin that passes data from an input connection to an output connection."""
+
+    def __init__(self, provider: AMPProviderV2):
+        """Construct a plugin."""
+        self.provider = provider
+        self.provider.io.info("AyxSdkOutput tool started")
+
+    def on_record_batch(self, batch: "pa.Table", anchor: Anchor) -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batch
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection']) containing input connection identifiers.
+        """
+        self.provider.io.info(batch.to_string().replace("\n", " | "))
+
+    def on_incoming_connection_complete(self, anchor: Anchor) -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection.
+        """
+        self.provider.io.info(
+            f"Received complete update from {anchor.name}:{anchor.connection}."
+        )
+
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        self.provider.io.info(f"AyxSdkOutput tool done.")

another_ayx_python_sdk/examples/AyxSdkPassThrough/AyxSdkPassThrough.xml

@@ -0,0 +1,23 @@
+<AlteryxJavaScriptPlugin>
+	<EngineSettings EngineDll="Python" EngineDllEntryPoint="main.py" SDKVersion="10.1" ToolFamily="AyxPluginSdkExamples" />
+	<GuiSettings Html="index.html" Icon="icon.png" SDKVersion="10.1">
+		<InputConnections>
+			<Connection AllowMultiple="False" Label="" Name="Input" Optional="False" Type="Connection" />
+		</InputConnections>
+		<OutputConnections>
+			<Connection AllowMultiple="False" Label="" Name="Output" Optional="False" Type="Connection" />
+		</OutputConnections>
+	</GuiSettings>
+	<Properties>
+		<MetaInfo>
+			<Name>AyxSdkPassThrough</Name>
+			<Description>Example pass through tool</Description>
+			<ToolVersion>1.0</ToolVersion>
+			<CategoryName>SDK Examples</CategoryName>
+			<SearchTags>python, sdk, python sdk</SearchTags>
+			<Author>Alteryx, Inc.</Author>
+			<Company>Alteryx, Inc.</Company>
+			<Copyright>2020</Copyright>
+		</MetaInfo>
+	</Properties>
+</AlteryxJavaScriptPlugin>

another_ayx_python_sdk/examples/AyxSdkPassThrough/main.py

@@ -0,0 +1,82 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Example pass through tool."""
+from typing import TYPE_CHECKING
+
+from another_ayx_python_sdk.core import (
+    Anchor,
+    PluginV2,
+)
+from another_ayx_python_sdk.providers.amp_provider.amp_provider_v2 import AMPProviderV2
+
+if TYPE_CHECKING:
+    import pyarrow as pa
+
+
+class AyxSdkPassThrough(PluginV2):
+    """A sample Plugin that passes data from an input connection to an output connection."""
+
+    def __init__(self, provider: AMPProviderV2):
+        """Construct the plugin."""
+        self.name = "AyxSdkPassThrough"
+        self.provider = provider
+        self.provider.io.info(f"{self.name} tool started")
+
+    def on_record_batch(self, batch: "pa.Table", anchor: Anchor) -> None:
+        """
+        Process the passed record batch.
+
+        The method that gets called whenever the plugin receives a record batch on an input.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        batch
+            A pyarrow Table containing the received batch.
+        anchor
+            A namedtuple('Anchor', ['name', 'connection']) containing input connection identifiers.
+        """
+        self.provider.write_to_anchor("Output", batch)
+
+    def on_incoming_connection_complete(self, anchor: Anchor) -> None:
+        """
+        Call when an incoming connection is done sending data including when no data is sent on an optional input anchor.
+
+        This method IS NOT called during update-only mode.
+
+        Parameters
+        ----------
+        anchor
+            NamedTuple containing anchor.name and anchor.connection.
+        """
+        self.provider.io.info(
+            f"Received complete update from {anchor.name}:{anchor.connection}."
+        )
+
+    def on_complete(self) -> None:
+        """
+        Clean up any plugin resources, or push records for an input tool.
+
+        This method gets called when all other plugin processing is complete.
+
+        In this method, a Plugin designer should perform any cleanup for their plugin.
+        However, if the plugin is an input-type tool (it has no incoming connections),
+        processing (record generation) should occur here.
+
+        Note: A tool with an optional input anchor and no incoming connections should
+        also write any records to output anchors here.
+        """
+        self.provider.io.info(f"{self.name} tool done.")

another_ayx_python_sdk/examples/requirements.txt

@@ -0,0 +1,18 @@
+ayx_python_sdk
+Click==7.1.2
+grpcio==1.28.1
+grpcio-tools==1.28.1
+numpy==1.19.1
+pandas==1.1.0
+protobuf==3.20.1
+psutil==5.6.3
+pydantic==1.5.1
+python-dateutil==2.8.1
+pytz==2020.1
+setuptools==46.1.3
+six==1.14.0
+typer==0.3.1
+xmltodict==0.12.0
+pyarrow==5.0.0
+deprecation==2.1.0
+wincertstore==0.2

another_ayx_python_sdk/providers/__init__.py

@@ -0,0 +1,14 @@
+# Copyright (C) 2022 Alteryx, Inc. All rights reserved.
+#
+# Licensed under the ALTERYX SDK AND API LICENSE AGREEMENT;
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.alteryx.com/alteryx-sdk-and-api-license-agreement
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Alteryx Python SDK: RecordProviders."""