| Name | kedro-airflow JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | |
| Summary | Kedro-Airflow makes it easy to deploy Kedro projects to Airflow |
| upload_time | 2023-12-20 15:50:01 |
| maintainer | |
| docs_url | None |
| author | Kedro |
| requires_python | >=3.8 |
| license | Apache Software License (Apache 2.0) |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Kedro-Airflow
[](https://opensource.org/licenses/Apache-2.0)
[](https://pypi.org/project/kedro-airflow/)
[](https://pypi.org/project/kedro-airflow/)
[](https://github.com/ambv/black)
[Apache Airflow](https://github.com/apache/airflow) is a tool for orchestrating complex workflows and data processing pipelines. The Kedro-Airflow plugin can be used for:
- Rapid pipeline creation in the prototyping phase. You can write Python functions in Kedro without worrying about schedulers, daemons, services or having to recreate the Airflow DAG file.
- Automatic dependency resolution in Kedro. This allows you to bypass Airflow's need to specify the order of your tasks.
- Distributing Kedro tasks across many workers. You can also enable monitoring and scheduling of the tasks' runtimes.
## Installation
`kedro-airflow` is a Python plugin. To install it:
```bash
pip install kedro-airflow
```
## Usage
You can use `kedro-airflow` to deploy a Kedro pipeline as an Airflow DAG by following these steps:
### Step 1: Generate the DAG file
At the root directory of the Kedro project, run:
```bash
kedro airflow create
```
This command will generate an Airflow DAG file located in the `airflow_dags/` directory in your project.
You can pass a `--pipeline` flag to generate the DAG file for a specific Kedro pipeline and an `--env` flag to generate the DAG file for a specific Kedro environment.
Passing `--all` will convert all registered Kedro pipelines to Airflow DAGs.
### Step 2: Copy the DAG file to the Airflow DAGs folder.
For more information about the DAGs folder, please visit [Airflow documentation](https://airflow.apache.org/docs/stable/concepts.html#dags).
The Airflow DAG configuration can be customized by editing this file.
### Step 3: Package and install the Kedro pipeline in the Airflow executor's environment
After generating and deploying the DAG file, you will then need to package and install the Kedro pipeline into the Airflow executor's environment.
Please visit the guide to [deploy Kedro as a Python package](https://docs.kedro.org/en/stable/deployment/single_machine.html#package-based) for more details.
### FAQ
#### What if my DAG file is in a different directory to my project folder?
By default, the generated DAG file is configured to live in the same directory as your project as per this [template](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/kedro_airflow/airflow_dag_template.j2#L44). If your DAG file is located in a different directory to your project, you will need to tweak this manually after running the `kedro airflow create` command.
#### What if I want to use a different Jinja2 template?
You can use the additional command line argument `--jinja-file` (alias `-j`) to provide an alternative path to a Jinja2 template. Note that these files have to accept the same variables as those used in the [default Jinja2 template](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/kedro_airflow/airflow_dag_template.j2).
```bash
kedro airflow create --jinja-file=./custom/template.j2
```
#### How can I pass arguments to the Airflow DAGs dynamically?
`kedro-airflow` picks up configuration from `airflow.yml` in `conf/base` or `conf/local` of your Kedro project.
Or it could be in a folder starting with `airflow`.
The [parameters](https://docs.kedro.org/en/stable/configuration/parameters.html) are read by Kedro.
Arguments can be specified globally, or per pipeline:
```yaml
# Global parameters
default:
start_date: [2023, 1, 1]
max_active_runs: 3
# https://airflow.apache.org/docs/stable/scheduler.html#dag-runs
schedule_interval: "@once"
catchup: false
# Default settings applied to all tasks
owner: "airflow"
depends_on_past: false
email_on_failure: false
email_on_retry: false
retries: 1
retry_delay: 5
# Arguments specific to the pipeline (overrides the parameters above)
data_science:
owner: "airflow-ds"
```
Arguments can also be passed via `--params` in the command line:
```bash
kedro airflow create --params "schedule_interval='@weekly'"
```
These variables are passed to the Jinja2 template that creates an Airflow DAG from your pipeline.
### What if I want to use a configuration pattern other than `airflow*` and `airflow**`?
In order to configure the config loader, update the `settings.py` file in your Kedro project.
For instance, if you would like to use the name `scheduler`, then change the file as follows:
```python
CONFIG_LOADER_ARGS = {"config_patterns": {"airflow": ["scheduler*", "scheduler/**"]}}
```
Follow Kedro's [official documentation](https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-do-templating-with-the-omegaconfigloader), to see how to add templating, custom resolvers etc.
#### What if I want to pass different arguments?
In order to pass arguments other than those specified in the default template, simply pass a custom template (see: _"What if I want to use a different Jinja2 template?"_)
The syntax for arguments is:
```
{{ argument_name }}
```
In order to make arguments optional, one can use:
```
{{ argument_name | default("default_value") }}
```
For examples, please have a look at the default template (`airflow_dag_template.j2`).
### What if I want to use a configuration file other than `airflow.yml`?
The default configuration pattern is `["airflow*", "airflow/**"]`.
In order to configure the `OmegaConfigLoader`, update the `settings.py` file in your Kedro project as follows:
```python
from kedro.config import OmegaConfigLoader
CONFIG_LOADER_CLASS = OmegaConfigLoader
CONFIG_LOADER_ARGS = {
# other args
"config_patterns": { # configure the pattern for configuration files
"airflow": ["airflow*", "airflow/**"]
}
}
```
Follow Kedro's official documentation, to see how to add templating, custom resolvers etc. (https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-do-templating-with-the-omegaconfigloader)[https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-do-templating-with-the-omegaconfigloader]
#### How can I use Airflow runtime parameters?
It is possible to pass parameters when triggering an Airflow DAG from the user interface.
In order to use this feature, create a custom template using the [Params syntax](https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/params.html).
See ["What if I want to use a different Jinja2 template?"](#what-if-i-want-to-use-a-different-jinja2-template) for instructions on using custom templates.
#### What if I want to use a different Airflow Operator?
Which Airflow Operator to use depends on the environment your project is running in.
You can set the operator to use by providing a custom template.
See ["What if I want to use a different Jinja2 template?"](#what-if-i-want-to-use-a-different-jinja2-template) for instructions on using custom templates.
The [rich offering](https://airflow.apache.org/docs/apache-airflow-providers/operators-and-hooks-ref/index.html) of operators means that the `kedro-airflow` plugin is providing templates for specific operators.
The default template provided by `kedro-airflow` uses the `BaseOperator`.
## Can I contribute?
Yes! Want to help build Kedro-Airflow? Check out our guide to [contributing](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/CONTRIBUTING.md).
## What licence do you use?
Kedro-Airflow is licensed under the [Apache 2.0](https://github.com/kedro-org/kedro-plugins/blob/main/LICENSE.md) License.
## Python version support policy
* The [Kedro-Airflow](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-airflow) supports all Python versions that are actively maintained by the CPython core team. When a [Python version reaches end of life](https://devguide.python.org/versions/#versions), support for that version is dropped from `kedro-airflow`. This is not considered a breaking change.
Raw data
{
"_id": null,
"home_page": "",
"name": "kedro-airflow",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Kedro",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d7/be/a78c640d3fe73c7186db29875f32bd220bb7216166ac8254f66a1522c716/kedro-airflow-0.8.0.tar.gz",
"platform": null,
"description": "# Kedro-Airflow\n\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://pypi.org/project/kedro-airflow/)\n[](https://pypi.org/project/kedro-airflow/)\n[](https://github.com/ambv/black)\n\n[Apache Airflow](https://github.com/apache/airflow) is a tool for orchestrating complex workflows and data processing pipelines. The Kedro-Airflow plugin can be used for:\n- Rapid pipeline creation in the prototyping phase. You can write Python functions in Kedro without worrying about schedulers, daemons, services or having to recreate the Airflow DAG file.\n- Automatic dependency resolution in Kedro. This allows you to bypass Airflow's need to specify the order of your tasks.\n- Distributing Kedro tasks across many workers. You can also enable monitoring and scheduling of the tasks' runtimes.\n\n## Installation\n\n`kedro-airflow` is a Python plugin. To install it:\n\n```bash\npip install kedro-airflow\n```\n\n## Usage\n\nYou can use `kedro-airflow` to deploy a Kedro pipeline as an Airflow DAG by following these steps:\n\n### Step 1: Generate the DAG file\n\nAt the root directory of the Kedro project, run:\n\n```bash\nkedro airflow create\n```\n\nThis command will generate an Airflow DAG file located in the `airflow_dags/` directory in your project.\nYou can pass a `--pipeline` flag to generate the DAG file for a specific Kedro pipeline and an `--env` flag to generate the DAG file for a specific Kedro environment.\nPassing `--all` will convert all registered Kedro pipelines to Airflow DAGs.\n\n### Step 2: Copy the DAG file to the Airflow DAGs folder.\n\nFor more information about the DAGs folder, please visit [Airflow documentation](https://airflow.apache.org/docs/stable/concepts.html#dags).\nThe Airflow DAG configuration can be customized by editing this file.\n\n### Step 3: Package and install the Kedro pipeline in the Airflow executor's environment\n\nAfter generating and deploying the DAG file, you will then need to package and install the Kedro pipeline into the Airflow executor's environment.\nPlease visit the guide to [deploy Kedro as a Python package](https://docs.kedro.org/en/stable/deployment/single_machine.html#package-based) for more details.\n\n### FAQ\n\n#### What if my DAG file is in a different directory to my project folder?\n\nBy default, the generated DAG file is configured to live in the same directory as your project as per this [template](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/kedro_airflow/airflow_dag_template.j2#L44). If your DAG file is located in a different directory to your project, you will need to tweak this manually after running the `kedro airflow create` command.\n\n#### What if I want to use a different Jinja2 template?\n\nYou can use the additional command line argument `--jinja-file` (alias `-j`) to provide an alternative path to a Jinja2 template. Note that these files have to accept the same variables as those used in the [default Jinja2 template](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/kedro_airflow/airflow_dag_template.j2).\n\n```bash\nkedro airflow create --jinja-file=./custom/template.j2\n```\n\n#### How can I pass arguments to the Airflow DAGs dynamically?\n\n`kedro-airflow` picks up configuration from `airflow.yml` in `conf/base` or `conf/local` of your Kedro project.\nOr it could be in a folder starting with `airflow`.\nThe [parameters](https://docs.kedro.org/en/stable/configuration/parameters.html) are read by Kedro.\nArguments can be specified globally, or per pipeline:\n\n```yaml\n# Global parameters\ndefault:\n start_date: [2023, 1, 1]\n max_active_runs: 3\n # https://airflow.apache.org/docs/stable/scheduler.html#dag-runs\n schedule_interval: \"@once\"\n catchup: false\n # Default settings applied to all tasks\n owner: \"airflow\"\n depends_on_past: false\n email_on_failure: false\n email_on_retry: false\n retries: 1\n retry_delay: 5\n\n# Arguments specific to the pipeline (overrides the parameters above)\ndata_science:\n owner: \"airflow-ds\"\n```\n\nArguments can also be passed via `--params` in the command line:\n\n```bash\nkedro airflow create --params \"schedule_interval='@weekly'\"\n```\n\nThese variables are passed to the Jinja2 template that creates an Airflow DAG from your pipeline.\n\n### What if I want to use a configuration pattern other than `airflow*` and `airflow**`?\n\nIn order to configure the config loader, update the `settings.py` file in your Kedro project.\nFor instance, if you would like to use the name `scheduler`, then change the file as follows:\n\n```python\nCONFIG_LOADER_ARGS = {\"config_patterns\": {\"airflow\": [\"scheduler*\", \"scheduler/**\"]}}\n```\n\nFollow Kedro's [official documentation](https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-do-templating-with-the-omegaconfigloader), to see how to add templating, custom resolvers etc.\n\n#### What if I want to pass different arguments?\n\nIn order to pass arguments other than those specified in the default template, simply pass a custom template (see: _\"What if I want to use a different Jinja2 template?\"_)\n\nThe syntax for arguments is:\n```\n{{ argument_name }}\n```\n\nIn order to make arguments optional, one can use:\n```\n{{ argument_name | default(\"default_value\") }}\n```\n\nFor examples, please have a look at the default template (`airflow_dag_template.j2`).\n\n### What if I want to use a configuration file other than `airflow.yml`?\n\nThe default configuration pattern is `[\"airflow*\", \"airflow/**\"]`.\nIn order to configure the `OmegaConfigLoader`, update the `settings.py` file in your Kedro project as follows:\n\n```python\nfrom kedro.config import OmegaConfigLoader\n\nCONFIG_LOADER_CLASS = OmegaConfigLoader\nCONFIG_LOADER_ARGS = {\n # other args\n \"config_patterns\": { # configure the pattern for configuration files\n \"airflow\": [\"airflow*\", \"airflow/**\"]\n }\n}\n```\n\nFollow Kedro's official documentation, to see how to add templating, custom resolvers etc. (https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-do-templating-with-the-omegaconfigloader)[https://docs.kedro.org/en/stable/configuration/advanced_configuration.html#how-to-do-templating-with-the-omegaconfigloader]\n\n#### How can I use Airflow runtime parameters?\n\nIt is possible to pass parameters when triggering an Airflow DAG from the user interface.\nIn order to use this feature, create a custom template using the [Params syntax](https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/params.html).\nSee [\"What if I want to use a different Jinja2 template?\"](#what-if-i-want-to-use-a-different-jinja2-template) for instructions on using custom templates.\n\n#### What if I want to use a different Airflow Operator?\n\nWhich Airflow Operator to use depends on the environment your project is running in.\nYou can set the operator to use by providing a custom template.\nSee [\"What if I want to use a different Jinja2 template?\"](#what-if-i-want-to-use-a-different-jinja2-template) for instructions on using custom templates.\nThe [rich offering](https://airflow.apache.org/docs/apache-airflow-providers/operators-and-hooks-ref/index.html) of operators means that the `kedro-airflow` plugin is providing templates for specific operators.\nThe default template provided by `kedro-airflow` uses the `BaseOperator`.\n\n## Can I contribute?\n\nYes! Want to help build Kedro-Airflow? Check out our guide to [contributing](https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/CONTRIBUTING.md).\n\n## What licence do you use?\n\nKedro-Airflow is licensed under the [Apache 2.0](https://github.com/kedro-org/kedro-plugins/blob/main/LICENSE.md) License.\n\n## Python version support policy\n* The [Kedro-Airflow](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-airflow) supports all Python versions that are actively maintained by the CPython core team. When a [Python version reaches end of life](https://devguide.python.org/versions/#versions), support for that version is dropped from `kedro-airflow`. This is not considered a breaking change.\n",
"bugtrack_url": null,
"license": "Apache Software License (Apache 2.0)",
"summary": "Kedro-Airflow makes it easy to deploy Kedro projects to Airflow",
"version": "0.8.0",
"project_urls": {
"Documentation": "https://github.com/kedro-org/kedro-plugins/blob/main/kedro-airflow/README.md",
"Source": "https://github.com/kedro-org/kedro-plugins/tree/main/kedro-airflow",
"Tracker": "https://github.com/kedro-org/kedro-plugins/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f15554db13f58c1072d56bbe3fd6e99421cdac4fdf502614903984135e241ef1",
"md5": "3459426e3d54ab82f65305a476505a50",
"sha256": "626b78d0634aeef8d6b7dc56b9975ff6b96dccf77f7bdd8fbe4124b47dfd37d4"
},
"downloads": -1,
"filename": "kedro_airflow-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3459426e3d54ab82f65305a476505a50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8128,
"upload_time": "2023-12-20T15:49:52",
"upload_time_iso_8601": "2023-12-20T15:49:52.000864Z",
"url": "https://files.pythonhosted.org/packages/f1/55/54db13f58c1072d56bbe3fd6e99421cdac4fdf502614903984135e241ef1/kedro_airflow-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7bea78c640d3fe73c7186db29875f32bd220bb7216166ac8254f66a1522c716",
"md5": "4b4dbfadc89fecb124f26408213e4996",
"sha256": "1bb5d90d0fe70b5d862564a439076e442799c8f9db905951c01ded77d1b2a0c0"
},
"downloads": -1,
"filename": "kedro-airflow-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "4b4dbfadc89fecb124f26408213e4996",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10082,
"upload_time": "2023-12-20T15:50:01",
"upload_time_iso_8601": "2023-12-20T15:50:01.164164Z",
"url": "https://files.pythonhosted.org/packages/d7/be/a78c640d3fe73c7186db29875f32bd220bb7216166ac8254f66a1522c716/kedro-airflow-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-20 15:50:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kedro-org",
"github_project": "kedro-plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kedro-airflow"
}
