Installation

Requirements

PocketProtector requires Python 3.10 or newer.

Dependencies are installed automatically:

  • PyNaCl – cryptographic operations (Curve25519, Argon2id)

  • ruamel.yaml – YAML parsing and serialization

  • attrs – data classes

  • vendored boltons utilities (pocket_protector._vendor, BSD-licensed, copied from boltons 25.0.0) – atomic saves and ordered multidict

  • schema – data validation

  • face – CLI framework

Install from PyPI

pip install pocket_protector

Verify the installation:

$ pprotect version
pocket_protector version 26.0.0

The package installs two equivalent console scripts: pprotect (short form) and pocket_protector.

Development install

To work on PocketProtector itself:

git clone https://github.com/mahmoud/pocket_protector.git
cd pocket_protector
pip install -e ".[dev]"

Run tests with:

pytest