Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
b65254d
Add setup guide for Apache Airflow on Mac M1 and above
praneeth552 May 4, 2025
5b3c3f9
Add Apple Silicon setup instructions for Apache Airflow
praneeth552 May 4, 2025
e8d76b8
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
ba39797
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
b55b283
Update README.md
praneeth552 May 5, 2025
db096a9
Update README.md
praneeth552 May 5, 2025
c2b9c89
clean up the doc
praneeth552 May 5, 2025
3c8dd7a
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
9e9c156
further polished and refined the doc
praneeth552 May 5, 2025
ed733f4
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
fff3a69
Moved installation instructions to INSTALLING.md
praneeth552 May 5, 2025
97a6e79
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
2620f5b
Merge branch 'airflow-mac-setup-doc' of https://github.com/praneeth55…
praneeth552 May 5, 2025
6bc7433
Refined entire installation section in README.MD and moved to INSTALL…
praneeth552 May 5, 2025
c80dbcf
further refined
praneeth552 May 5, 2025
de230c1
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
207473a
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
3d8a9d5
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
38eaf55
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
a780674
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
7149184
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 5, 2025
8581675
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 May 6, 2025
8977b05
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 6, 2025
eedf805
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 6, 2025
974515f
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 6, 2025
bb742bc
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 6, 2025
1d3ce0e
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 7, 2025
eabb51a
separated the installation steps
praneeth552 May 7, 2025
faab8c2
Merge branch 'airflow-mac-setup-doc' of https://github.com/praneeth55…
praneeth552 May 7, 2025
d763f77
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 7, 2025
dfbdd5b
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 7, 2025
20877bf
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 8, 2025
a7a42a8
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 8, 2025
fd821a6
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 8, 2025
2db62f2
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 10, 2025
e6a3bca
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 10, 2025
23baf14
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 11, 2025
3de015c
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 12, 2025
1597a78
moved to down of the PyPI
praneeth552 May 14, 2025
0ee2984
Merge branch 'airflow-mac-setup-doc' of https://github.com/praneeth55…
praneeth552 May 14, 2025
6e60525
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 May 14, 2025
f2e640c
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 14, 2025
b871a23
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 14, 2025
ef4bf09
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 15, 2025
564264b
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 15, 2025
d582ed3
Merge branch 'apache:main' into airflow-mac-setup-doc
praneeth552 May 15, 2025
e0b0f0e
Merge branch 'main' into airflow-mac-setup-doc
praneeth552 May 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 103 additions & 0 deletions INSTALLING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<!--
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.
-->

## Local Development Setup

This section outlines a recommended approach for setting up a local development environment for Apache Airflow on macOS and Linux, primarily using PyEnv for Python version management.

> ⚠️ Avoid using either system-installed Python or Python from Homebrew, as these versions are often labeled `--externally-managed` resulting in restricted dependency installation.

You can use other ways to install Python and airflow. Airflow development setup requires `uv` and if you want to setup environment for development, `uv` is the only supported local development environment setup, because we are using `uv workspace` extensively. See [local virtualenv setup in contributing docs](https://github.com/apache/airflow/blob/main/contributing-docs/07_local_virtualenv.rst) for details.

If you are just installing airflow to run it locally, You can use other ways to set up your Python and virtualenv: `uv` is one of the options (refer to `uv` documentation), but you can also use more traditional tools - for example `pyenv`. Note that it is recommended to install airflow with constraints - at least initially - because this way you can reproducibly install airflow. See [Installation from PyPI](https://airflow.apache.org/docs/apache-airflow/stable/installation/installing-from-pypi.html) for more details.

### ✅ Setup using pyenv:

1. **Install pyenv (macOS and Linux)**:

```bash
brew install pyenv
```

(Note: Homebrew is the recommended method on macOS. For Linux, you can typically install pyenv using the `pyenv-installer` script as detailed in the official documentation: [https://github.com/pyenv/pyenv#installation](https://github.com/pyenv/pyenv#installation).)

2. **Install Python**:

```bash
pyenv install 3.11.9
pyenv global 3.11.9
```

3. **Check Python version**:

```bash
python --version
```

4. **Create and Activate a Virtual Environment**: Since Apache Airflow requires multiple dependencies, it's a good practice to isolate these dependencies in a virtual environment.

- Create a virtual environment:

```bash
python -m venv airflow_venv
```

- Activate the virtual environment:

```bash
source airflow_venv/bin/activate
```

5. **Install Apache Airflow**: Apache Airflow is available on PyPI. To install it, you can use the following command in your terminal:

```bash
pip install apache-airflow==3.0.0 --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.0/constraints-3.11.txt"
```

Note that installing with constraints - at least initially - is recommended for reproducible installation. It might sometimes happen that 3rd-party distributions are released and their latest versions break airflow. Using constraints makes the installation reproducible with versions of dependencies that were "frozen" at the time of releasing airflow. Note you have to specify both - airflow version and Python version you are using.

You can also specify additional extras - when you want to install airflow with additional providers:

```bash
pip install apache-airflow[amazon,google]==3.0.0 --constraint "https://raw.githubusercontent.com/apache/airflow/constraints-3.0.0/constraints-3.11.txt"
```

6. **Set the AIRFLOW_HOME Environment Variable**: Apache Airflow requires a directory to store configuration files, logs, and other data. Set the AIRFLOW_HOME variable to specify this directory.

- Set the Airflow home directory:

```bash
export AIRFLOW_HOME=~/airflow
```

7. **Run Airflow in standalone mode**: Apache Airflow runs several components, like the scheduler, web server, and API server, to manage workflows and show the UI.

- To run Airflow in standalone mode (which will automatically start the required components):

```bash
airflow standalone
```

8. **Access the Airflow Web UI**: Once the components are up and running, you can access the Airflow UI through your browser:

- Open your browser and go to:

```text
http://localhost:8080
```
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Use Airflow to author workflows as directed acyclic graphs (DAGs) of tasks. The
- [Requirements](#requirements)
- [Getting started](#getting-started)
- [Installing from PyPI](#installing-from-pypi)
- [Installation](#installation)
- [Official source code](#official-source-code)
- [Convenience packages](#convenience-packages)
- [User Interface](#user-interface)
Expand Down Expand Up @@ -139,6 +140,7 @@ Documentation for dependent projects like provider distributions, Docker image,

<!-- END Getting started, please keep comment here to allow auto update of PyPI readme.md -->
<!-- START Installing from PyPI, please keep comment here to allow auto update of PyPI readme.md -->

## Installing from PyPI

We publish Apache Airflow as `apache-airflow` package in PyPI. Installing it however might be sometimes tricky
Expand All @@ -154,7 +156,6 @@ 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.
Expand Down Expand Up @@ -189,6 +190,11 @@ For information on installing provider distributions, check
[providers](http://airflow.apache.org/docs/apache-airflow-providers/index.html).

<!-- END Installing from PyPI, please keep comment here to allow auto update of PyPI readme.md -->

## Installation

For comprehensive instructions on setting up your local development environment and installing Apache Airflow, please refer to the [INSTALLING.md](INSTALLING.md) file.

<!-- START Official source code, please keep comment here to allow auto update of PyPI readme.md -->
## Official source code

Expand Down
2 changes: 1 addition & 1 deletion generated/PYPI_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ the [Airflow Wiki](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+I

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
Expand All @@ -108,7 +109,6 @@ 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.
Expand Down