Skip to main content

Apache Airflow plugin for viewing and editing variables with JSON display

Project description

airflow-variable-json-viewer

An Apache Airflow plugin that adds a dedicated page for viewing and editing variables with JSON value display.

Features

  • ๐Ÿ“‹ View all Airflow variables in a list
  • โœ๏ธ Edit variable values with JSON pretty-printing
  • ๐Ÿ“ Import variables from variables.json file (from AIRFLOW_HOME)
  • ๐Ÿ”’ Display variable encryption status

Compatibility

  • Apache Airflow 2.8+
  • Python 3.8+

Installation

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 via the airflow.plugins entry point.


Usage

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

The plugin is available at:

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

Import from file

Place a variables.json file in the AIRFLOW_HOME directory:

{
  "my_variable": "some_value",
  "another_variable": {"key": "value"}
}

Then click the "Import from file" button in the plugin UI (if available) or use the API endpoint.


Project Structure

airflow-variable-json-viewer/
โ”œโ”€โ”€ variable_json_viewer/       # Plugin Python package
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ plugin.py
โ”‚   โ””โ”€โ”€ static/
โ”‚       โ”œโ”€โ”€ index.html
โ”‚       โ”œโ”€โ”€ app.js
โ”‚       โ””โ”€โ”€ styles.css
โ”œโ”€โ”€ pyproject.toml
โ”œโ”€โ”€ README.md
โ””โ”€โ”€ LICENSE

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.0.tar.gz (9.2 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.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airflow_variable_json_viewer-0.1.0.tar.gz
  • Upload date:
  • Size: 9.2 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.0.tar.gz
Algorithm Hash digest
SHA256 5b626d1986af60de80e1a3f7dc3e195b171edd701a355aa7106867443135b3f8
MD5 3933821ab9ca7fbd0a58ba713eda724b
BLAKE2b-256 5295173d1cc0bd588dd471467d8fe89d53786ff822ea13fc08ac74c0996d04fc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airflow_variable_json_viewer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ab333907d295308a15d930567c08d5547f4e4aa2629444f6dc58bf740aed763
MD5 751d43ed8538652856de4cb1216ea81e
BLAKE2b-256 94f714211e11e95ab34a4ca76f6aad7ebed2f8544869ebd68d44d50338e4976a

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