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 default Variables UI is hard to use when working with JSON values:

  • No formatting or readability
  • Difficult to edit complex structures
  • Limited visibility into nested data

Default Airflow Variables UI
Default Airflow UI without 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.1.1.tar.gz (9.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.1.1-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airflow_variable_json_viewer-0.1.1.tar.gz
  • Upload date:
  • Size: 9.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.1.1.tar.gz
Algorithm Hash digest
SHA256 81427a9b1109f45b40a0bafb73c2cb90ff516210c2004f551702eb4ed0260f65
MD5 b46cccec1df8a1d05717948869c384ba
BLAKE2b-256 a32a9beacb6708209720bd16cc824c47d879da56be7466ef7cba5fefa05bd12b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airflow_variable_json_viewer-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 599b049272128418a8672e9a30b4bb51eedb3e1234df5fbb51452ef02fa76ead
MD5 280c9be7a39bb9f45b59ba209e85d82b
BLAKE2b-256 905216de732e692c91b2b8d0b1097b72d581329371af83e8eb86dc40b88e8873

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