airflow-code-editor 3.2.0

Apache Airflow code editor and file manager

Airflow Code Editor Plugin

A plugin for Apache Airflow that allows you to edit DAGs in browser. It provides a file managing interface within specified directories and it can be used to edit and download your files. The DAGs are stored in a Git repository. You may use it to view Git history, review local changes and commit.

System Requirements

• Airflow Versions
  • 1.10.3 or newer
• git Versions
  • 2.0 or newer

Screenshots

Deployment Instructions

1. Install the plugin

   pip install airflow-code-editor

2. (Optional) Install Black Python code formatter.

   pip install black

3. Restart the Airflow Web Server

4. Open Admin - DAGs Code Editor

Config Options

You can edit your airflow.cfg adding any of the following settings in the [code_editor] section.

• git_cmd git command (optional path)
• git_default_args git arguments added to each call (default: -c color.ui=true)
• git_author_name human-readable name in the author/committer (default logged user first and last names)
• git_author_email email for the author/committer (default: logged user email)
• git_init_repo initialize a git repo in DAGs folder (default: True)
• root_directory root folder (default: Airflow DAGs folder)
• mount_name configure additional file folder name (mount point)
• mount_path configure additional file path
• line_length Python code formatter - max line length (default: 88)
• string_normalization Python code formatter - if true normalize string quotes and prefixes (default: False)

Example:

   [code_editor]
   git_cmd = /usr/bin/git
   git_default_args = -c color.ui=true
   git_init_repo = False
   root_directory = /home/airflow/dags
   line_length = 88
   string_normalization = False
   mount_name = data
   mount_path = /home/airflow/data
   mount1_name = logs
   mount1_path = /home/airflow/logs

Links

• Apache Airflow - https://github.com/apache/airflow
• Codemirror, In-browser code editor - https://github.com/codemirror/codemirror
• Git WebUI, A standalone local web based user interface for git repositories - https://github.com/alberthier/git-webui
• Black, The Uncompromising Code Formatter - https://github.com/psf/black