README.md

gem

(GnuPG encryption module)

third-party module used: gnupg

linux program used: gpg

gem provides easy encryption to a default or explicit public key. It can be used

1. as a Linux CLI tool
2. as a Python module

gem as a Linux CLI tool

gem "cleartext" [pub_key_file_name] [pub_key_file_path]

gem accepts piped string input

echo "Hello" | gem

gem as a Python module

import gem

encrypted_str = gem.main(clear_text, 
                         pubkey_file_name='pubkey.asc', 
                         pubkey_file_path='/path/to/pubkey/')

(rename or copy the file gem to gem.py before importing)

When executed with no arguments or piped input, gem takes input from the keyboard

gem

(end keyboard input with CTRL-D)

cle

(clipboard encryption) (needs xclip to be installed on linux)

cle encrypts the clipboard content in place

cle

(custom keyboard shortcut execution recommended)