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.1.0.tar.gz
(10.5 kB
view hashes)
Built Distribution
Close
Hashes for airflow_code_editor-3.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 534d07fbddb99ad821910aa5fa4bc2cfa96800c0ed67351c18a6c410d74f5bb5 |
|
MD5 | edae4c29fcd6bf3e393c42fcf69ac055 |
|
BLAKE2b-256 | fa7bc3f3a05629e8adfc2f720e118bab5735c3787be9add0b74f98da4c5b5217 |
Close
Hashes for airflow_code_editor-3.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0b240ddcc6f577d38085e631e45f08a883236ee266b9b0b93ef8b84c42a7c2a |
|
MD5 | 4bb973f4e2476803c614cc3fa2a25934 |
|
BLAKE2b-256 | 2b0a05809206a9bc15dae222fe18dac59d3e2dcf7241f907992dfade6d8de7a5 |