Skip to main content

Logo

Description

PyPI - Version PyPI - Python Version PyPI - Status PyPI - Downloads PyPI - License Gitea Issues Gitea Last Commit

Pawpyrus is a minimalist open-source paper data storage based on QR codes and ArUco. It generates a PDF from any small-sized binary file (recommended size <100kb). Further, the paper data storage can be scanned and decoded (recommended resolution 300dpi).

It can be useful if you need to backup data on paper:

  • Encryption keys (e.g. GnuPG)
  • File-based password databases (e.g. KeePassXC)
  • Cryptocurrency wallets

Installation

The script is pure Python and a part of PyPI, so can be installed via pip:

python3 -m pip install pawpyrus

Usage

Encoder:

pawpyrus Encode -n "Description" -i  "input.file" -o "output.pdf"

Also, pawpyrus can read data from stdin. For example, encoding GPG public keys:

gpg --export 0xDEADBEEF | pawpyrus Encode -n "My pubkey" -i - -o "my-pubkey.pdf"

Decoder:

pawpyrus Decode -i "scan1.jpg" "scan2.png" "scan3.jpg" "masked/too/*.png" -o "output.file"

Data Format

Pawpyrus uses a custom alphanumeric encoding, which is designed to store information in QR code quite effectively. For now, that makes 4.3kb per A4 page (pixel size 0.6 mm).

Got a Trouble?

QR and ArUco detectors may fail on one or several blocks. The situation is totally normal, although uncomfortable. It's fixed for now, with two detectors (opencv and pyzbar) instead of one, but the bug may reappear in some circumstances. That's why Debug Mode was implemented:

pawpyrus Decode -d "debug_dir" -i "scan1.jpg" "scan2.jpg" "scan3.jpg" -o "output.file"

With Debug Mode, you can inspect undetected QR codes, read them manually with any device you have, and create a file with text blocks which can be processed as well:

pawpyrus Decode "scan1.jpg" "scan2.jpg" "scan3.jpg" -t "unrecognized_codes.txt" -o "output.file"

If you have any idea how to fix the bug better, give me a clue.

Similar Projects

  1. intra2net/paperbackup
  2. Paperback by Olly and Wikinaut/paperback-cli
  3. colorsafe/colorsafe
  4. Twibright Optar
  5. Paperkey
  6. 4bitfocus/asc-key-to-qr-code

Metadata

Release files for pawpyrus 2026.6.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pawpyrus 2026.6.5.0
File Size Uploaded Provenance
pawpyrus-2026.6.5.0.tar.gz 63.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pawpyrus 2026.6.5.0
File Interpreter ABI Platform
pawpyrus-2026.6.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 86.9 kB

Release files / pawpyrus-2026.6.5.0.tar.gz

Download URL pawpyrus-2026.6.5.0.tar.gz
Size 63.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e22055b3f7bcb49982cd6c7ce105f8ae43d9046d690698f9cdd71d9d6827cdd9
BLAKE2b-256 checksum
How to use checksums
5d73cfa55c61e6ec8948cc7988f7ffe8a04ab46d18b8284c62532915c57be2ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.13

Release files / pawpyrus-2026.6.5.0-py3-none-any.whl

Download URL pawpyrus-2026.6.5.0-py3-none-any.whl
Size 23.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
276c90f4692e9928c1254a31ca8e771117dbcc3a5564a61e6b40fc019b5fa607
BLAKE2b-256 checksum
How to use checksums
8aa288691bbe889fe6257cdedccd0821d95d4063bdf301cd760c18c4dee03231
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.13

Security for pawpyrus 2026.6.5.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page