Skip to main content

Apache Airflow plugin for viewing and editing variables with JSON display

Project description

PyPI Python

airflow-variable-json-viewer

A better way to work with JSON-based Airflow Variables.

A modern Airflow UI plugin for browsing and editing Variables with formatted JSON, search, and an improved user experience.

Variables JSON Viewer plugin UI
Editing variables with formatted JSON

Quick start

pip install airflow-variable-json-viewer

Why?

Airflow’s Variables UI is now more of a pain than a UX update:

  • Smaller input field — large data barely fits
  • No variable renaming — must recreate instead
  • No JSON formatting (before 3.1.8) — all data in one line

Default Airflow Variables UI
Default Airflow (<3.1.8) UI without JSON formatting

Default Airflow Variables UI
Default Airflow (3.1.8 or greater) UI with JSON formatting

This plugin provides a clean and user-friendly interface for working with JSON-based variables.

Features

  • 📋 Browse all Airflow variables with instant search
  • ✏️ Edit values with automatic JSON formatting
  • 🔍 Easily read and navigate complex nested structures
  • 🔒 View variable encryption status
  • 🌓 Built-in dark and light modes

Light mode UI
Light mode support

Compatibility

  • Apache Airflow 3.1+
  • Python 3.8+

Installation

You can install the plugin either manually or via pip:

Option 1: Manual copy to plugins folder

  1. Copy the variable_json_viewer/ package to your Airflow plugins folder:

    $AIRFLOW_HOME/plugins/variable_json_viewer/
    ├── __init__.py
    ├── plugin.py
    └── static/
        ├── index.html
        ├── app.js
        └── styles.css
    
  2. Restart Airflow (webserver and scheduler).

Option 2: Installation via pip

pip install airflow-variable-json-viewer

After installation, restart Airflow — the plugin will be automatically discovered.


Usage

After installation, a new menu item "Variables JSON Viewer" will appear in the Airflow navigation menu under the Admin section.

Or access it directly via:

http://<your-airflow-host>/variable-json/

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airflow_variable_json_viewer-0.2.0.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airflow_variable_json_viewer-0.2.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file airflow_variable_json_viewer-0.2.0.tar.gz.

File metadata

  • Download URL: airflow_variable_json_viewer-0.2.0.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.2 Linux/6.6.12-linuxkit

File hashes

Hashes for airflow_variable_json_viewer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0b4cb67dd5cf8ebfdd2a3219a136b973ca1b25f3d641791908db32e29711e452
MD5 e4417ec7bde734fac84b480e137abfb7
BLAKE2b-256 37b5cc572e69d87ff4ece0a3977b7a75c41b96d09c46b5c4916cbb2955cad943

See more details on using hashes here.

File details

Details for the file airflow_variable_json_viewer-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for airflow_variable_json_viewer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c0f1a20d3d66cd3a153dc9f72a0586e5e106e0966004ebc8e62dc0f9b759b24
MD5 4e2a42c3d0690fb9f147ff965ada7f46
BLAKE2b-256 1f62e9f56ff2331da1e1df2e35aeaaa0b4969db5b0dfb0507f86761162a30238

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page