| Name | pawpyrus JSON |
| Version |
2024.8.3.0
JSON |
| download |
| home_page | None |
| Summary | A minimalist paper data storage based on QR codes |
| upload_time | 2024-08-03 17:41:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
aruco
qr
data storage
paper
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Description
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](https://gnupg.org))
* File-based password databases (e.g. [KeePassXC](https://keepassxc.org))
* Cryptocurrency wallets
## Installation
The script is pure Python and a part of [PyPI](https://pypi.org/project/pawpyrus), so can be installed via *pip*:
```bash
python3 -m pip install pawpyrus
```
## Usage
Encoder:
```bash
pawpyrus Encode -n "Description" -i "input.file" -o "output.pdf"
```
Also, pawpyrus can read data from stdin.
For example, encoding GPG public keys:
```bash
gpg --export 0xDEADBEEF | pawpyrus Encode -n "My pubkey" -i - -o "my-pubkey.pdf"
```
Decoder:
```bash
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](https://github.com/opencv/opencv-python) and [pyzbar](https://github.com/NaturalHistoryMuseum/pyzbar)) instead of one, but the bug may reappear in some circumstances.
That's why Debug Mode was implemented:
```bash
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:
```bash
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](https://codeberg.org/screwery/pawpyrus/issues).
## Similar Projects
1. [intra2net/paperbackup](https://github.com/intra2net/paperbackup)
2. [Paperback by Olly](https://ollydbg.de/Paperbak/) and [Wikinaut/paperback-cli](https://github.com/Wikinaut/paperback-cli)
3. [colorsafe/colorsafe](https://github.com/colorsafe/colorsafe)
4. [Twibright Optar](http://ronja.twibright.com/optar)
5. [Paperkey](https://www.jabberwocky.com/software/paperkey)
6. [4bitfocus/asc-key-to-qr-code](https://github.com/4bitfocus/asc-key-to-qr-code)
Raw data
{
"_id": null,
"home_page": null,
"name": "pawpyrus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "ArUco, QR, data storage, paper",
"author": null,
"author_email": "Ellie Viesn\u00e1 <snowboard_refinery@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/1c/36/099b2e4e85472f2f79193985d92c6ce17f53eb468fc8135a960712d8c1d8/pawpyrus-2024.8.3.0.tar.gz",
"platform": null,
"description": "\n\n## Description\n\n\n\n\n\n\n\n\n\nPawpyrus is a minimalist open-source paper data storage based on QR codes and ArUco.\nIt generates a PDF from any small-sized binary file (recommended size <100kb).\nFurther, the paper data storage can be scanned and decoded (recommended resolution 300dpi).\n\nIt can be useful if you need to backup data on paper:\n\n* Encryption keys (e.g. [GnuPG](https://gnupg.org))\n* File-based password databases (e.g. [KeePassXC](https://keepassxc.org))\n* Cryptocurrency wallets\n\n## Installation\n\nThe script is pure Python and a part of [PyPI](https://pypi.org/project/pawpyrus), so can be installed via *pip*:\n\n```bash\npython3 -m pip install pawpyrus\n```\n\n## Usage\n\nEncoder:\n\n```bash\npawpyrus Encode -n \"Description\" -i \"input.file\" -o \"output.pdf\"\n```\n\nAlso, pawpyrus can read data from stdin.\nFor example, encoding GPG public keys:\n\n```bash\ngpg --export 0xDEADBEEF | pawpyrus Encode -n \"My pubkey\" -i - -o \"my-pubkey.pdf\"\n```\n\nDecoder:\n\n```bash\npawpyrus Decode -i \"scan1.jpg\" \"scan2.png\" \"scan3.jpg\" \"masked/too/*.png\" -o \"output.file\"\n```\n\n## Data Format\n\nPawpyrus uses a custom alphanumeric encoding, which is designed to store information in QR code quite effectively.\nFor now, that makes 4.3kb per A4 page (pixel size 0.6 mm).\n\n## Got a Trouble?\n\n**QR and ArUco detectors may fail on one or several blocks.**\nThe situation is totally normal, although uncomfortable.\nIt's fixed for now, with two detectors ([opencv](https://github.com/opencv/opencv-python) and [pyzbar](https://github.com/NaturalHistoryMuseum/pyzbar)) instead of one, but the bug may reappear in some circumstances.\nThat's why Debug Mode was implemented:\n\n```bash\npawpyrus Decode -d \"debug_dir\" -i \"scan1.jpg\" \"scan2.jpg\" \"scan3.jpg\" -o \"output.file\"\n```\n\nWith 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:\n\n```bash\npawpyrus Decode \"scan1.jpg\" \"scan2.jpg\" \"scan3.jpg\" -t \"unrecognized_codes.txt\" -o \"output.file\"\n```\n\nIf you have any idea how to fix the bug better, [give me a clue](https://codeberg.org/screwery/pawpyrus/issues).\n\n## Similar Projects\n\n1. [intra2net/paperbackup](https://github.com/intra2net/paperbackup)\n2. [Paperback by Olly](https://ollydbg.de/Paperbak/) and [Wikinaut/paperback-cli](https://github.com/Wikinaut/paperback-cli)\n3. [colorsafe/colorsafe](https://github.com/colorsafe/colorsafe)\n4. [Twibright Optar](http://ronja.twibright.com/optar)\n5. [Paperkey](https://www.jabberwocky.com/software/paperkey)\n6. [4bitfocus/asc-key-to-qr-code](https://github.com/4bitfocus/asc-key-to-qr-code)\n",
"bugtrack_url": null,
"license": null,
"summary": "A minimalist paper data storage based on QR codes",
"version": "2024.8.3.0",
"project_urls": {
"Changelog": "https://codeberg.org/screwery/pawpyrus/src/branch/main/CHANGELOG.md",
"Issues": "https://codeberg.org/screwery/pawpyrus/issues",
"Repository": "https://codeberg.org/screwery/pawpyrus"
},
"split_keywords": [
"aruco",
" qr",
" data storage",
" paper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1cd08fc1ec2075465c47ec0f8bb5dd917cb56279c1a7c3de4b5a40970d81058",
"md5": "7b21e7f405ec2901e3bbe7c7e3bd23a7",
"sha256": "80b398414f638fdf2b17c56408df1707883acdd9749eddeaea41adaa5d6da4c3"
},
"downloads": -1,
"filename": "pawpyrus-2024.8.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7b21e7f405ec2901e3bbe7c7e3bd23a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 23676,
"upload_time": "2024-08-03T17:41:51",
"upload_time_iso_8601": "2024-08-03T17:41:51.450949Z",
"url": "https://files.pythonhosted.org/packages/c1/cd/08fc1ec2075465c47ec0f8bb5dd917cb56279c1a7c3de4b5a40970d81058/pawpyrus-2024.8.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c36099b2e4e85472f2f79193985d92c6ce17f53eb468fc8135a960712d8c1d8",
"md5": "67d89660ad9cc56f059c794c478c543e",
"sha256": "95be0b32e55cff6a2b3d04f64ff9007842fb3c941eec35f0932874bb0a1f45c1"
},
"downloads": -1,
"filename": "pawpyrus-2024.8.3.0.tar.gz",
"has_sig": false,
"md5_digest": "67d89660ad9cc56f059c794c478c543e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 63114,
"upload_time": "2024-08-03T17:41:53",
"upload_time_iso_8601": "2024-08-03T17:41:53.727860Z",
"url": "https://files.pythonhosted.org/packages/1c/36/099b2e4e85472f2f79193985d92c6ce17f53eb468fc8135a960712d8c1d8/pawpyrus-2024.8.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-03 17:41:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": true,
"codeberg_user": "screwery",
"codeberg_project": "pawpyrus",
"lcname": "pawpyrus"
}
