Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 3.34 KB

CONTRIBUTORS_QUICK_START_GITPOD.rst

File metadata and controls

96 lines (65 loc) · 3.34 KB
Raw

Connect your project to Gitpod

  1. Goto https://github.com/apache/airflow/ and fork the project.

    Forking Apache Airflow project

  2. Goto your github account's fork of airflow click on Code and copy the clone link.

    Cloning github fork of Apache airflow

  3. Add goto https://gitpod.io/#<copied-url> as shown.

    Open personal airflow clone with Gitpod

Set up Breeze in Gitpod

Gitpod default image have all the required packages installed.

  1. Run pipx install -e ./dev/breeze to install Breeze

Warning

If you see below warning - it means that you hit known issue with packaging version 23.2: ⚠️ Ignoring --editable install option. pipx disallows it for anything but a local path, to avoid having to create a new src/ directory.

The workaround is to downgrade packaging to 23.1 and re-running the pipx install command. for example by running pip install "packaging<23.2".

  1. Run breeze to enter breeze in Gitpod.

Setting up database in Breeze

Once you enter breeze environment is initialized, create airflow tables and users from the breeze CLI. The airflow db reset command is required to execute at least once for Airflow Breeze to get the database/tables created. When you run the tests, your database will be initialized automatically the first time you run tests.

Note

This step is needed when you would like to run/use webserver.

root@b76fcb399bb6:/opt/airflow# airflow db reset
root@b76fcb399bb6:/opt/airflow# airflow users create --role Admin --username admin --password admin \
  --email admin@example.com --firstname foo --lastname bar

Follow the Quick start for typical development tasks.