Airflow plugin to work with GPG files.
Project description
Airflow GPG Plugin
Airflow plugin with hooks and operators to work with GPG encryption and decryption.
Installation
Use the package manager pip to install foobar.
pip install airflow-gpg-plugin
Usage
Add an airflow connection from shell.
login
is the email address in the GPG key.
password
is the passphrase of the GPG key.
airflow connections add 'gpg_default_conn' \
--conn-type 'gpg' \
--conn-login 'gpgexamplepassphrase@example.com' \
--conn-password 'gpgexamplepassphrase' \
--conn-host '' \
--conn-port '' \
--conn-extra '{"key_file": "tests/resources/gpgexamplepassphrase.asc"}'
Using operators to encrypt and decrypt files.
import os
from datetime import datetime
from airflow import DAG
from airflow_gpg_plugin.operators.gpg_decrypt_file_operator import GPGDecryptFileOperator
from airflow_gpg_plugin.operators.gpg_encrypt_file_operator import GPGEncryptFileOperator
gpg_conn_id = "gpg_default_conn"
dag = DAG(dag_id="gpg_example",
start_date=datetime(2021, 1, 1),
schedule_interval=None
)
encrypt = GPGEncryptFileOperator(
task_id="gpg_encrypt",
dag=dag,
conn_id=gpg_conn_id,
input_file_path=os.curdir + "/README.md",
output_file_path=os.curdir + "/README.md.gpg"
)
decrypt = GPGDecryptFileOperator(
task_id="gpg_decrypt",
dag=dag,
conn_id=gpg_conn_id,
input_file_path=os.curdir + "/README.md.gpg",
output_file_path=os.curdir + "/README.md.txt"
)
encrypt >> decrypt
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
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
Built Distribution
Close
Hashes for airflow_gpg_plugin-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e429d00f1fffb2d2e7ceb08bf873dfb6d9056f347b05a8bb9db61fb7047d901 |
|
MD5 | d7769715fe5627fae1dd66d0f1839337 |
|
BLAKE2b-256 | 6833ca3bc0ba55cbf5386149ca9f4f085e14c520367547dbd327b4463859b9a4 |