Skip to main content

A minimalist paper data storage based on QR codes

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pawpyrus-2026.6.5.0.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pawpyrus-2026.6.5.0-py3-none-any.whl (23.7 kB view details)

Uploaded Python 3

File details

Details for the file pawpyrus-2026.6.5.0.tar.gz.

File metadata

  • Download URL: pawpyrus-2026.6.5.0.tar.gz
  • Upload date:
  • Size: 63.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for pawpyrus-2026.6.5.0.tar.gz
Algorithm Hash digest
SHA256 e22055b3f7bcb49982cd6c7ce105f8ae43d9046d690698f9cdd71d9d6827cdd9
MD5 d4a94879f0264d025fbf09dbe2890e37
BLAKE2b-256 5d73cfa55c61e6ec8948cc7988f7ffe8a04ab46d18b8284c62532915c57be2ea

See more details on using hashes here.

File details

Details for the file pawpyrus-2026.6.5.0-py3-none-any.whl.

File metadata

  • Download URL: pawpyrus-2026.6.5.0-py3-none-any.whl
  • Upload date:
  • Size: 23.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for pawpyrus-2026.6.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 276c90f4692e9928c1254a31ca8e771117dbcc3a5564a61e6b40fc019b5fa607
MD5 b05a13e8e6e22b0d3f06a0e0fa5b0626
BLAKE2b-256 8aa288691bbe889fe6257cdedccd0821d95d4063bdf301cd760c18c4dee03231

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page