Apache Airflow code editor and file manager
Project description
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
-
Install the plugin
pip install airflow-code-editor
-
(Optional) Install Black Python code formatter.
pip install black
-
Restart the Airflow Web Server
-
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
airflow_code_editor-3.3.3.tar.gz
(10.9 kB
view hashes)
Built Distribution
Close
Hashes for airflow_code_editor-3.3.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7697bb2ec37691073c4cc71469dd169e8f6f9da4467b414bbddd3a5511d2bae |
|
MD5 | 6c7f6e2108ab808731336affdd54b68e |
|
BLAKE2b-256 | 2e419125aa3fe03a22c6a3e43ed78b46885b2d22e91d3618120ea9787c9842e1 |
Close
Hashes for airflow_code_editor-3.3.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfd0176e2ae3333f0130a27836a5bc00a1963ab6fb0b4f4a446952a58651fd96 |
|
MD5 | a187b8d9d81aef00d74204ef4d607bb5 |
|
BLAKE2b-256 | bee70b61f86af6c25d7c0d45bed7cf97ebf21975edf2c1aeb945d82ba75ab3c7 |