Python PGP Check

A quick python CLI tool to verify file PGP hashes

Installation and usage

Install it with python pip using

pip install python-pgp-check

Usage

Calculate Hash

to calculate the hash of a file:

python-pgp-check <file_path>

Verify Hash

To verify a file against an expected hash:

python-pgp-check <file_path> <expected_hash>

Specifying Hash Algorithm

By default, SHA-256 is used. To use a different algorithm:

python-pgp-check <file_path> [<expected_hash>] --algorithm <algorithm>

Supported algorithms: md5, sha1, sha256, sha512

Examples

Calculate SHA-256 hash:

python-pgp-check /path/to/file

Verify file with SHA-256 hash:

python-pgp-check /path/to/file 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8

Calculate MD5 hash:

python-pgp-check /path/to/file --algorithm md5

Verify file with SHA-512 hash:

python-pgp-check /path/to/file 3c9909afec25354d551dae21590bb26e38d53f2173b8d3dc3eee4c047e7ab1c1eb8b85103e3be7ba613b31bb5c9c36214dc9f14a42fd7a2fdb84856bca5c44c2 --algorithm sha512

Dev Setup

1. Create a virtual environment:

# On Windows
python -m venv venv

# On macOS/Linux
python3 -m venv venv

2. Activate the virtual environment:

# On Windows
venv\Scripts\activate

# On macOS/Linux
source venv/bin/activate

Installation Options

Option 1: Development Installation

1. Install dependencies:

pip install -r requirements.txt

2. Run the CLI directly for testing:

python src/pgp_check/cli.py

Option 2: Package Installation

1. Install the package in editable mode:

pip install -e .

Verification

Test the it installed correctly:

# If installed with Option 2
python-pgp-check --version

Notes

• Always ensure your virtual environment is activated before running commands (you should see (venv) in your terminal prompt)
• Use deactivate to exit the virtual environment when done
• If you encounter permission errors, you may need to use sudo (Linux/macOS) or run as administrator (Windows)