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
1 maintainer
Release files for airflow-code-editor 3.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airflow_code_editor-3.2.0.tar.gz | 10.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airflow_code_editor-3.2.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 1.1 MB
Release files / airflow_code_editor-3.2.0.tar.gz
| Download URL | airflow_code_editor-3.2.0.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0d2e4b55516c6bc8da799c0670a93b18bfc7c41f2d5be6b99bfe3db303a5ee27
|
|
BLAKE2b-256 checksum How to use checksums |
850e30c776930e06576fcf07594149771ed239515581d3eb8c4a0635f0c75589
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/2.7.18
|
Release files / airflow_code_editor-3.2.0-py2.py3-none-any.whl
| Download URL | airflow_code_editor-3.2.0-py2.py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
270dbadc21769f53bc5c66bdb8498f8317f6fc89a056dbe2657cc87fc5632fe6
|
|
BLAKE2b-256 checksum How to use checksums |
a9e8bf69efd9bb3696295836b42a8be59e656a9ec39aafa5c6f23e3d8049f0ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/2.7.18
|
