| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you 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. |
| --> |
| |
| <!-- PLEASE DO NOT MODIFY THIS FILE. IT HAS BEEN GENERATED AUTOMATICALLY FROM THE `README.md` FILE OF THE |
| PROJECT BY THE `generate-pypi-readme` PREK HOOK. YOUR CHANGES HERE WILL BE AUTOMATICALLY OVERWRITTEN.--> |
| |
| # Apache Airflow |
| |
| | Badges | | |
| |------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| | License | [](https://www.apache.org/licenses/LICENSE-2.0.txt) | |
| | PyPI | [](https://badge.fury.io/py/apache-airflow) [](https://pypi.org/project/apache-airflow/) [](https://pypi.org/project/apache-airflow/) | |
| | Containers | [](https://hub.docker.com/r/apache/airflow) [](https://hub.docker.com/r/apache/airflow) [](https://artifacthub.io/packages/search?repo=apache-airflow) | |
| | Community | [](https://github.com/apache/airflow/graphs/contributors) [](https://s.apache.org/airflow-slack)  [](https://ossrank.com/p/6) | |
| |
| |
| |
| | Version | Build Status | |
| |---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| | Main | [](https://github.com/apache/airflow/actions) [](https://github.com/apache/airflow/actions) | |
| | 3.x | [](https://github.com/apache/airflow/actions) [](https://github.com/apache/airflow/actions) | |
| | 2.x | [](https://github.com/apache/airflow/actions) | |
| |
| |
| |
| <picture width="500"> |
| <img |
| src="https://github.com/apache/airflow/blob/19ebcac2395ef9a6b6ded3a2faa29dc960c1e635/docs/apache-airflow/img/logos/wordmark_1.png?raw=true" |
| alt="Apache Airflow logo" |
| /> |
| </picture> |
| |
| [Apache Airflow](https://airflow.apache.org/docs/apache-airflow/stable/) (or simply Airflow) is a platform to programmatically author, schedule, and monitor workflows. |
| |
| When workflows are defined as code, they become more maintainable, versionable, testable, and collaborative. |
| |
| Use Airflow to author workflows (Dags) that orchestrate tasks. The Airflow scheduler executes your tasks on an array of workers while following the specified dependencies. Rich command line utilities make performing complex surgeries on DAGs a snap. The rich user interface makes it easy to visualize pipelines running in production, monitor progress, and troubleshoot issues when needed. |
| |
| ## Requirements |
| |
| Apache Airflow is tested with: |
| |
| | | Main version (dev) | Stable version (3.0.6) | |
| |------------|------------------------------|------------------------| |
| | Python | 3.10, 3.11, 3.12, 3.13 | 3.9, 3.10, 3.11, 3.12 | |
| | Platform | AMD64/ARM64(\*) | AMD64/ARM64(\*) | |
| | Kubernetes | 1.30, 1.31, 1.32, 1.33, 1.34 | 1.30, 1.31, 1.32, 1.33 | |
| | PostgreSQL | 13, 14, 15, 16, 17 | 13, 14, 15, 16, 17 | |
| | MySQL | 8.0, 8.4, Innovation | 8.0, 8.4, Innovation | |
| | SQLite | 3.15.0+ | 3.15.0+ | |
| |
| \* Experimental |
| |
| **Note**: MariaDB is not tested/recommended. |
| |
| **Note**: SQLite is used in Airflow tests. Do not use it in production. We recommend |
| using the latest stable version of SQLite for local development. |
| |
| **Note**: Airflow currently can be run on POSIX-compliant Operating Systems. For development, it is regularly |
| tested on fairly modern Linux Distros and recent versions of macOS. |
| On Windows you can run it via WSL2 (Windows Subsystem for Linux 2) or via Linux Containers. |
| The work to add Windows support is tracked via [#10388](https://github.com/apache/airflow/issues/10388), but |
| it is not a high priority. You should only use Linux-based distros as "Production" execution environment |
| as this is the only environment that is supported. The only distro that is used in our CI tests and that |
| is used in the [Community managed DockerHub image](https://hub.docker.com/p/apache/airflow) is |
| `Debian Bookworm`. |
| |
| ## Getting started |
| |
| Visit the official Airflow website documentation (latest **stable** release) for help with |
| [installing Airflow](https://airflow.apache.org/docs/apache-airflow/stable/installation/), |
| [getting started](https://airflow.apache.org/docs/apache-airflow/stable/start.html), or walking |
| through a more complete [tutorial](https://airflow.apache.org/docs/apache-airflow/stable/tutorial/). |
| |
| > Note: If you're looking for documentation for the main branch (latest development branch): you can find it on [s.apache.org/airflow-docs](https://s.apache.org/airflow-docs/). |
| |
| For more information on Airflow Improvement Proposals (AIPs), visit |
| the [Airflow Wiki](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals). |
| |
| Documentation for dependent projects like provider distributions, Docker image, Helm Chart, you'll find it in [the documentation index](https://airflow.apache.org/docs/). |
| |
| |
| ## Installing from PyPI |
| |
| We publish Apache Airflow as `apache-airflow` package in PyPI. Installing it however might be sometimes tricky |
| because Airflow is a bit of both a library and application. Libraries usually keep their dependencies open, and |
| applications usually pin them, but we should do neither and both simultaneously. We decided to keep |
| our dependencies as open as possible (in `pyproject.toml`) so users can install different versions of libraries |
| if needed. This means that `pip install apache-airflow` will not work from time to time or will |
| produce unusable Airflow installation. |
| |
| To have repeatable installation, however, we keep a set of "known-to-be-working" constraint |
| files in the orphan `constraints-main` and `constraints-2-0` branches. We keep those "known-to-be-working" |
| constraints files separately per major/minor Python version. |
| You can use them as constraint files when installing Airflow from PyPI. Note that you have to specify |
| correct Airflow tag/version/branch and Python versions in the URL. |
| |
| 1. Installing just Airflow: |
| |
| > Note: Only `pip` installation is currently officially supported. |
| |
| While it is possible to install Airflow with tools like [Poetry](https://python-poetry.org) or |
| [pip-tools](https://pypi.org/project/pip-tools), they do not share the same workflow as |
| `pip` - especially when it comes to constraint vs. requirements management. |
| Installing via `Poetry` or `pip-tools` is not currently supported. |
| |
| There are known issues with ``bazel`` that might lead to circular dependencies when using it to install |
| Airflow. Please switch to ``pip`` if you encounter such problems. ``Bazel`` community works on fixing |
| the problem in `this PR <https://github.com/bazelbuild/rules_python/pull/1166>`_ so it might be that |
| newer versions of ``bazel`` will handle it. |
| |
| If you wish to install Airflow using those tools, you should use the constraint files and convert |
| them to the appropriate format and workflow that your tool requires. |
| |
| |
| ```bash |
| pip install 'apache-airflow==3.0.6' \ |
| --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.6/constraints-3.10.txt" |
| ``` |
| |
| 2. Installing with extras (i.e., postgres, google) |
| |
| ```bash |
| pip install 'apache-airflow[postgres,google]==3.0.6' \ |
| --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.6/constraints-3.10.txt" |
| ``` |
| |
| For information on installing provider distributions, check |
| [providers](http://airflow.apache.org/docs/apache-airflow-providers/index.html). |
| |
| ## Official source code |
| |
| Apache Airflow is an [Apache Software Foundation](https://www.apache.org) (ASF) project, |
| and our official source code releases: |
| |
| - Follow the [ASF Release Policy](https://www.apache.org/legal/release-policy.html) |
| - Can be downloaded from [the ASF Distribution Directory](https://downloads.apache.org/airflow) |
| - Are cryptographically signed by the release manager |
| - Are officially voted on by the PMC members during the |
| [Release Approval Process](https://www.apache.org/legal/release-policy.html#release-approval) |
| |
| Following the ASF rules, the source packages released must be sufficient for a user to build and test the |
| release provided they have access to the appropriate platform and tools. |
| |
| |
| ## Contributing |
| |
| Want to help build Apache Airflow? Check out our [contributors' guide](https://github.com/apache/airflow/blob/main/contributing-docs/README.rst) for a comprehensive overview of how to contribute, including setup instructions, coding standards, and pull request guidelines. |
| |
| If you can't wait to contribute, and want to get started asap, check out the [contribution quickstart](https://github.com/apache/airflow/blob/main/contributing-docs/03_contributors_quick_start.rst) here! |
| |
| Official Docker (container) images for Apache Airflow are described in [images](https://github.com/apache/airflow/blob/main/dev/breeze/doc/ci/02_images.md). |
| |
| |
| ## Voting Policy |
| |
| * Commits need a +1 vote from a committer who is not the author |
| * When we do AIP voting, both PMC member's and committer's `+1s` are considered a binding vote. |
| |
| ## Who uses Apache Airflow? |
| |
| We know about around 500 organizations that are using Apache Airflow (but there are likely many more) |
| [in the wild](https://github.com/apache/airflow/blob/main/INTHEWILD.md). |
| |
| If you use Airflow - feel free to make a PR to add your organisation to the list. |
| |
| |
| ## Who maintains Apache Airflow? |
| |
| Airflow is the work of the [community](https://github.com/apache/airflow/graphs/contributors), |
| but the [core committers/maintainers](https://people.apache.org/committers-by-project.html#airflow) |
| are responsible for reviewing and merging PRs as well as steering conversations around new feature requests. |
| If you would like to become a maintainer, please review the Apache Airflow |
| [committer requirements](https://github.com/apache/airflow/blob/main/COMMITTERS.rst#guidelines-to-become-an-airflow-committer). |
