Skip to content

Passpy

passpy a platform independent library and cli that is compatible with ZX2C4's pass.

Installation

pip install passpy

Usage

To use passpy in your Python project, we will first have to create a new passpy.store.Store object.

import passpy

store = passpy.Store()

If git or gpg2 are not in your PATH you will have to specify them via git_bin and gpg_bin when creating the store object. You can also create the store on a different folder, be passing store_dir along.

Initialise a password store

To initialize the password store at store_dir, if it isn't already, use

store.init_store('store gpg id')

Where store gpg id is the name of a GPG ID. Optionally, git can be initialized in very much the same way.

store.init_git()

Set and get keys

You are now ready to interact with the password store. You can set and get keys using passpy.store.Store.set_key and passpy.store.Store.get_key.

passpy.store.Store.gen_key generates a new password for a new or existing key. To delete a key or directory, use passpy.store.Store.remove_path.

For a full overview over all available methods see store-module-label.

References