PyQtPass: Python Port of QtPass

Introduction

Welcome to PyQtPass, an experimental and early-stage Python port of the renowned QtPass, originally developed in C++. This initiative aims to leverage the versatility and simplicity of Python to enhance maintainability and extend the functionality of QtPass, a user-friendly GUI for pass, the standard Unix password manager.

QtPass has been a staple for users who prefer a graphical interface to manage their passwords securely and conveniently. Recognizing the growing Python ecosystem and its powerful libraries, PyQtPass is an endeavor to transition the application from C++ to Python. This move not only aligns with modern development practices but also opens up new avenues for features and improvements.

Project Status: Experimental

Please note that PyQtPass is currently in an early experimental phase. This means that while it encompasses the core functionalities of the original QtPass, it might not yet offer the full range of features, and you might encounter bugs or limitations that are typical in early-stage software.

We are actively developing PyQtPass and working towards a more stable and feature-rich version. Your feedback and contributions during this phase are invaluable and will help shape the future of this project.

Features

PyQtPass follows the feature set of QtPass 2.0:

• Talks to gpg and git directly, like QtPass's native backend; no Python password store library needed. Entries are written atomically, so a failing gpg never truncates a password.
• Tree view for password navigation; the search box matches its words literally and in order against the full path.
• Optional content search: press Enter to search the decrypted contents with a regular expression.
• Content panel showing the password and every field in its own row with a copy button, an "open in browser" button for web addresses and optional QR codes (with qrencode).
• Built-in TOTP one-time passwords (otpauth:// URIs or otp: fields, including Steam codes), no pass-otp needed.
• One dialog for adding and editing entries, with folder picker, field templates (e.g. login, url) and configurable password generation (including a custom character set).
• Adding, editing, renaming, duplicating and deleting passwords and folders; drag and drop to move (Ctrl to copy).
• Clipboard integration: copy never, on demand or automatically, optional X11 selection, automatic clearing after a timeout, and marked as secret so clipboard managers skip it.
• Git integration: pull and push in the background, automatic pull (on startup, before an edit and before re-encrypting) and automatic pushing of local changes; every change to the store is committed.
• Per-folder GPG recipients (the Users dialog, like pass init) with background re-encryption, import of keys from a file or the clipboard, key pair generation and exporting your public key to share a store.
• A first-run wizard that sets up a store, a key and Git for new users.
• A dockable process output panel showing what gpg and git were asked and what they said.
• Multiple password store profiles, switched from the toolbar, each with its own folder, signing key and Git behaviour.
• Signed recipient lists: with a signing key (like PASSWORD_STORE_SIGNING_KEY) every .gpg-id is signed and nothing is encrypted to a list that does not verify; rolled back lists, lists copied from another folder and swapped lists are refused (QtPass 2.0 compatible headers).
• Optionally runs the pass script itself for every change, for pass extensions and hooks.
• Links (and NTFS junctions) inside the store are never followed, and paths cannot escape the store.
• A menu bar that can be hidden (Ctrl+M); Alt shows it while you use it.
• System tray icon, start minimized, hide on close, always on top and a single running instance; pyqtpass <search text> searches in the running window.
• Cross-platform compatibility, thanks to the Python and PyQt6 combination.
• Available in the 64 languages QtPass is translated into, for the strings both programs share.

Installation

PyQtPass needs GnuPG (gpg or gpg2) with a graphical pinentry. Git is optional (for synchronisation) and so is qrencode (for QR codes).

Ready-made builds

Each release has:

• PyQtPass-<version>-windows-x64.exe for Windows;
• PyQtPass-<version>-macos-arm64.dmg for macOS (not signed: right-click the app and choose Open the first time);
• PyQtPass-<version>-x86_64.AppImage and a single-file PyQtPass-<version>-linux-x86_64 for Linux;
• PyQtPass-<version>.tar.gz and .zip with the source code.

To check a download:

• SHA256SUMS lists the checksums of every file: sha256sum --ignore-missing -c SHA256SUMS.
• A signed build provenance attestation (PyQtPass-<version>.intoto.jsonl) records which workflow run and commit built each file: gh attestation verify <file> --repo annejan/PyQtPass.
• Each file has a GnuPG signature by the maintainer (<file>.asc): gpg --verify <file>.asc <file>.

From PyPI

PyQtPass needs Python 3.11 or newer.

pipx install pyqtpass  # or: pip install pyqtpass
pyqtpass

The package on PyPI includes the translations.

From source

git clone https://github.com/annejan/PyQtPass.git
cd PyQtPass
pip install .          # installs the pyqtpass command
pyqtpass

Or run it without installing: pip install -r requirements.txt, then python -m pyqtpass.

Translations are compiled with Qt's lrelease (for example from the qt6-l10n-tools package); release builds include them:

lrelease pyqtpass/localization/*.ts

When no password store exists yet, a wizard helps you set one up.

Usage

Upon launching PyQtPass, you will see a split interface. On the left side is the tree view of your passwords, and on the right is the content panel of the selected entry. You can filter the entries using the search box above the tree view.

Fields are name: value lines below the password. Add a line like otpauth://totp/Example?secret=JBSWY3DPEHPK3PXP (or otp: JBSWY3DPEHPK3PXP) to an entry to get one-time passwords.

Templates decide which fields the password dialog always shows. Set one in the settings, or share them with everyone using the store, like QtPass does: a .templates file in the store root lists named templates, and a .default_template file in a folder names the one its entries use.

[website]
login
url

[server]
user
host

Portable mode

Like QtPass's qtpass.ini, an empty pyqtpass.ini next to the program (the PyQtPass executable of a ready-made build, or the pyqtpass script) makes PyQtPass keep its settings in that file instead of your user settings, for example to run it from a USB stick. The file is named after PyQtPass, not QtPass, because the two programs store different settings.

Security notes

• PyQtPass's own commits run with hooks disabled (core.hooksPath pointed at nothing, no fsmonitor), but git pull and git push run with your git setup, hooks included, like the command line does. Treat write access to the store's .git folder like write access to your account.
• With a signing key, a recipient list that does not verify, was removed, or was rolled back is refused rather than replaced by its parent's.

Development

pip install -r requirements-dev.txt
pylint $(git ls-files '*.py')
black --check .
QT_QPA_PLATFORM=offscreen python -m pytest --cov=pyqtpass

The tests create a throwaway GnuPG home and key, so they never touch your own keyring or store.

Contributions and Feedback

We warmly welcome contributions, be it in the form of code, translations, bug reports, suggestions, or documentation. CONTRIBUTING.md explains how to run the checks and how to translate PyQtPass.

Since PyQtPass is in its experimental stage, your input is crucial for its refinement and progression.

Should you encounter any issues or have feature suggestions, please feel free to open an issue on our GitHub issues page.

License

GNU GPL v3.0

View official GNU site

View the Open Source Initiative site

Acknowledgments

• pass: The standard Unix password manager. For more information, visit passwordstore.org.
• Qt Framework: PyQtPass utilizes the Qt Framework, specifically Qt 6, a comprehensive set of C++ libraries and development tools that enable the creation of cross-platform applications. Discover more about the Qt Framework at qt.io.
• QtPass: Qt GUI for Pass, written in C++, can be found at qtpass.org.
• Translations: PyQtPass reuses the translations QtPass's translators made on Weblate for the strings both programs share (GPL-3.0-or-later, like PyQtPass). scripts/import_qtpass_translations.py imports them again from a QtPass checkout.
• Co-Authorship: This project includes code and documentation co-written with the assistance of ChatGPT from OpenAI.
• Co-Authorship: The QtPass feature-parity work (clipboard, content panel, git sync, GPG user management, profiles, the native store backend, TOTP, templates, the first-run wizard and key management) and the PyQt6 migration were co-written with the assistance of Claude from Anthropic.