airflow-toolkit 0.13.3__tar.gz

airflow_toolkit-0.13.3/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

airflow_toolkit-0.13.3/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: airflow-toolkit
+Version: 0.13.3
+Summary: 
+License-File: LICENSE.txt
+Author: Biel Llobera
+Author-email: biel_llobera@dkl.digital
+Requires-Python: >=3.9,<3.12
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: airflow-provider-duckdb (>=0.2.0,<0.3.0)
+Requires-Dist: apache-airflow (>=2.8.0,<3.0.0)
+Requires-Dist: apache-airflow-providers-amazon (>=9.0.0,<10.0.0)
+Requires-Dist: apache-airflow-providers-google (>=10.23.0,<11.0.0)
+Requires-Dist: apache-airflow-providers-microsoft-azure (>=8.0.0,<9.0.0)
+Requires-Dist: apache-airflow-providers-sftp (>=4.8.1,<5.0.0)
+Requires-Dist: apache-airflow-providers-slack (>=8.5.1,<9.0.0)
+Requires-Dist: boto3 (>=1.34.8,<2.0.0)
+Requires-Dist: boto3-stubs (>=1.34.8,<2.0.0)
+Requires-Dist: databricks-sdk (>=0.21.0,<0.22.0)
+Requires-Dist: databricks-sql-connector (>=2)
+Requires-Dist: deltalake (>=0.17.4,<0.18.0)
+Requires-Dist: flask-session (==0.5.0)
+Requires-Dist: jmespath (>=1.0.1,<2.0.0)
+Requires-Dist: pandas (>=2.1.1,<3.0.0)
+Requires-Dist: pandas-stubs (>=2.1.4.231218,<3.0.0.0)
+Requires-Dist: paramiko (<4.0.0)
+Requires-Dist: pendulum (>=2.1.2,<3.0.0)
+Requires-Dist: sqlalchemy (==1.4.54)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: types-jmespath (>=1.0.2.7,<2.0.0.0)
+Requires-Dist: types-toml (>=0.10.8.7,<0.11.0.0)
+Description-Content-Type: text/markdown
+
+# Airflow Tools
+<div align="center">
+  <!-- Logo -->
+  <img src="./media/images/logo.webp" alt="logo" width="400"/>
+
+  <!-- Add some space between the logo and badges -->
+  <br/>
+
+  <!-- Badges -->
+  <a href="https://github.com/DeepKernelLabs/airflow-tools/actions?query=branch%3Amain">
+    <img src="https://github.com/DeepKernelLabs/airflow-tools/actions/workflows/lint-and-test.yml/badge.svg?branch=main" alt="Badge 1"/>
+  </a>
+  <a href="https://opensource.org/licenses/Apache-2.0">
+    <img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Badge 2"/>
+  </a>
+  <a href="https://img.shields.io/badge/python-3.10%20%7C%203.11-blue">
+    <img src="https://img.shields.io/badge/python-3.10%20%7C%203.11-blue" alt="Badge 3"/>
+  </a>
+
+  <br/><br/>
+</div>
+
+Collection of Operators, Hooks and utility functions aimed at facilitating ELT pipelines.
+
+## Overview
+
+This is an opinionated library focused on ELT, which means that our goal is to facilitate loading data from various data sources into a data lake, as well as loading from a data lake to a data warehouse and running transformations inside a data warehouse.
+
+Airflow's operators notoriously suffer from an NxM problem, where if you have N data sources and M destinations you end up with NxM different operators (FTPToS3, S3ToFTP, PostgresToS3, FTPToPostgres etc.). We aim to mitigate this issue in two ways:
+
+1. **ELT focused:** cuts down on the number of possible sources and destinations, as we always want to do `source` -> `data lake` -> `data warehouse`.
+2. **Building common interfaces:** where possible we want to treat similar data sources in the same way. Airflow recently has done a good job at this by deprecating all specific SQL operators (`PostgresOperator`, `MySQLOperator`, etc.) in favour of a more generic `SQLExecuteQueryOperator` that works with any hook compatible with the dbapi2 interface. We take this philosophy and apply it any time we can, like providing a unified interface for all filesystem data sources that then enables us to have much more generic operators like `SQLToFilesystem`, `FilesystemToFilesystem`.
+
+## Filesystem Interface/Protocol
+
+We provide a thin wrapper over many hooks for filesystem data sources. These wrappers use the hook's specific methods to implement some common methods that we then use inside the operators without needing to worry about the hook's specific type. For now we provide support for the following filesystem hooks, some of them native or that belong to other providers and others implemented in this library:
+
+- WasbHook (Blob Storage/ADLS)
+- S3Hook (S3)
+- SFTPHook (SFTP)
+- FSHook (Local Filesystem)
+- AzureFileShareServicePrincipalHook (Azure Fileshare with support for service principal authentication)
+- AzureDatabricksVolumeHook (Unity Catalog Columes)
+
+Operators can create the correct hook at runtime by passing a connection ID with a connection type of `aws` or `adls`. Example code:
+
+```python
+conn = BaseHook.get_connection(conn_id)
+hook = conn.get_hook()
+```
+
+## Operators
+### HTTP to Filesystem (Data Lake)
+
+Creates a
+Example usage:
+
+```python
+HttpToFilesystem(
+    task_id='test_http_to_data_lake',
+    http_conn_id='http_test',
+    data_lake_conn_id='data_lake_test',
+    data_lake_path=s3_bucket + '/source1/entity1/{{ ds }}/',
+    endpoint='/api/users',
+    method='GET',
+    jmespath_expression='data[:2].{id: id, email: email}',
+)
+```
+
+## Sensors
+
+### Filesystem (generic) File Sensor
+This sensor checks if a file exists in a generic filesystem.
+Type of filesystem is determined by the connection type.
+
+Current supported filesystem connections are (`conn_type` parameter):
+
+- `aws` (s3)
+- `azure_databricks_volume`
+- `azure_file_share_sp`
+- `sftp`
+- `fs` (LocalFileSystem)
+- `google_cloud_platform`
+- `wasb` (BlobStorageFilesystem)
+
+For example, with a connection with a S3 filesystem:
+
+```bash
+AIRFLOW_CONN_TEST_S3_FILESYSTEM='{"conn_type": "aws", "extra": {"endpoint_url": "http://localhost:9090"}}'
+```
+
+You can use a sensor like this:
+```python
+FilesystemFileSensor(
+    task_id='check_file_existence_exist_in_s3',
+    filesystem_conn_id='test_s3_filesystem',
+    source_path='data_lake/2023/10/01/test.csv',
+    poke_interval=60,
+    timeout=300,
+)
+```
+
+#### JMESPATH expressions
+APIs often return the response we are interested in wrapped in a key. JMESPATH expressions are a query language that we can use to select the response we are interested in. You can find more information on JMESPATH expressions and test them [here](https://jmespath.org/).
+
+The above expression selects the first two objects inside the key data, and then only the `id` and `email` attributes in each object. An example response can be found [here](https://reqres.in/api/users).
+
+## Tests
+### Integration tests
+To guarantee that the library works as intended we have an integration test that attempts to install it in a fresh virtual environment, and we aim to have a test for each Operator.
+
+#### Running integration tests locally
+The `lint-and-test.yml` [workflow](.github/workflows/lint-and-test.yml) sets up the necessary environment variables, but if you want to run them locally you will need the following environment variables:
+
+```shell
+AIRFLOW_CONN_DATA_LAKE_TEST='{"conn_type": "aws", "extra": {"endpoint_url": "http://localhost:9090"}}'
+AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+AWS_DEFAULT_REGION=us-east-1
+TEST_BUCKET=data_lake
+S3_ENDPOINT_URL=http://localhost:9090
+
+AIRFLOW_CONN_DATA_LAKE_TEST='{"conn_type": "aws", "extra": {"endpoint_url": "http://localhost:9090"}}' AIRFLOW_CONN_SFTP_TEST='{"conn_type": "sftp", "host": "localhost", "port": 22, "login": "test_user", "password": "pass"}' AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY TEST_BUCKET=data_lake S3_ENDPOINT_URL=http://localhost:9090 poetry run pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+AIRFLOW_CONN_SFTP_TEST='{"conn_type": "sftp", "host": "localhost", "port": 22, "login": "test_user", "password": "pass"}'
+```
+
+And you also need to run [Adobe's S3 mock container](https://github.com/adobe/S3Mock) like this:
+
+```shell
+docker run --rm -p 9090:9090 -e initialBuckets=data_lake -e debug=true -t adobe/s3mock
+```
+
+and the SFTP container like this:
+
+```shell
+docker run -p 22:22 -d atmoz/sftp test_user:pass:::root_folder
+```
+
+
+### Notifications
+
+#### Slack (incoming webhook)
+
+If your or your team are using slack, you can send and receive notifications about failed dags using `dag_failure_slack_notification_webhook` method
+(in `notifications.slack.webhook`). You need to create a new Slack App and enable the "Incoming Webhooks". More info about sending messages using
+Slack Incoming Webhooks [here](https://api.slack.com/messaging/webhooks).
+
+You need to create a new Airflow connection with the name `SLACK_WEBHOOK_NOTIFICATION_CONN` (or `AIRFLOW_CONN_SLACK_WEBHOOK_NOTIFICATION_CONN`
+if you are using environment variables.)
+
+Default message will have the format below:
+
+![image](https://github.com/DeepKernelLabs/airflow-tools/assets/152852247/52a5bf95-21bc-4c3b-8093-79953c0c5d61)
+
+But you can custom this message providing the below parameters:
+
+* **_text (str)[optional]:_** the main message will appear in the notification. If you provide your slack block will be ignored.
+* **_blocks (dict)[optional]:_** you can provide your custom slack blocks for your message.
+* **_include_blocks (bool)[optional]:_** indicates if the default block have to be used. If you provide your own blocks will be ignored.
+* **_source (typing.Literal['DAG', 'TASK'])[optional]:_** source of the failure (dag or task). Default: `DAG`.
+* **_image_url: (str)[optional]_** image url for you notification (`accessory`). You can use `AIRFLOW_TOOLS__SLACK_NOTIFICATION_IMG_URL` instead.
+
+##### Example of use in a Dag
+
+```python
+from datetime import datetime, timedelta
+
+from airflow import DAG
+
+from airflow.operators.bash import BashOperator
+from airflow_tools.notifications.slack.webhook import (
+    dag_failure_slack_notification_webhook,    # <--- IMPORT
+)
+
+with DAG(
+    "slack_notification_dkl",
+    description="Slack notification on fail",
+    schedule=timedelta(days=1),
+    start_date=datetime(2021, 1, 1),
+    catchup=False,
+    tags=["example"],
+    on_failure_callback=dag_failure_slack_notification_webhook(),  # <--- HERE
+) as dag:
+
+    t = BashOperator(
+        task_id="failing_test",
+        depends_on_past=False,
+        bash_command="exit 1",
+        retries=1,
+    )
+
+
+if __name__ == "__main__":
+    dag.test()
+```
+
+You can used only in a task providing the parameter `source='TASK'`:
+
+```python
+    t = BashOperator(
+        task_id="failing_test",
+        depends_on_past=False,
+        bash_command="exit 1",
+        retries=1,
+        on_failure_callback=dag_failure_slack_notification_webhook(source='TASK')
+    )
+```
+
+You can add a custom message (ignoring the slack blocks for a formatted message):
+
+```python
+with DAG(
+    ...
+    on_failure_callback=dag_failure_slack_notification_webhook(
+        text='The task {{ ti.task_id }} failed',
+        include_blocks=False
+    ),
+) as dag:
+```
+
+Or you can pass your own Slack blocks:
+
+```python
+custom_slack_blocks = {
+    "type": "section",
+    "text": {
+        "type": "mrkdwn",
+        "text": "<https://api.slack.com/reference/block-kit/block|This is an example using custom Slack blocks>"
+    }
+}
+
+with DAG(
+    ...
+    on_failure_callback=dag_failure_slack_notification_webhook(
+        blocks=custom_slack_blocks
+    ),
+) as dag:
+```
+