jcgruenhage/paperless-asn-qr-codes
1
0
Fork 0
mirror of https://github.com/entropia/paperless-asn-qr-codes.git synced 2024-11-03 09:04:57 +00:00
Code Issues Releases Packages Wiki Activity
No description
17 commits 2 branches 2 tags 159 KiB
Python 100%
Find a file
Alexander Sieg 13b80e0ada
chore: drop argparse from dependencies 
argparse is part of the python standard library since python 3.2, this
project is targeting at least python 3.7.

https://pypi.org/project/argparse/
2024-05-18 18:38:07 +02:00
.github/workflows feat: automatic build & publish, update authors 2024-04-29 18:36:29 +02:00
paperless_asn_qr_codes Add --digits option 2024-04-29 18:27:56 +02:00
.gitignore initial commit 2023-11-18 17:59:00 +01:00
LICENSE initial commit 2023-11-18 17:59:00 +01:00
pyproject.toml chore: drop argparse from dependencies 2024-05-18 18:38:07 +02:00
README.md Add --digits option 2024-04-29 18:27:56 +02:00

README.md

paperless-asn-qr-codes

paperless-asn-qr-codes is a command line utility for generating ASN labels for paperless with both a human-readable representation, as well as a QR code for machine consumption. The labels are Avery 4731 labels.

Installation

pip install paperless-asn-qr-codes

Usage

usage: paperless-asn-qr-codes [-h] [--format {averyL4731,avery5160,avery5161,avery5163,avery5167,avery5371}] [--border] start_asn output_file

CLI Tool for generating paperless ASN labels with QR codes

positional arguments:
  start_asn             The value of the first ASN
  output_file           The output file to write to (default: labels.pdf)

options:
  -h, --help            show this help message and exit
  --format {averyL4731,avery5160,avery5161,avery5163,avery5167,avery5371}, -f {averyL4731,avery5160,avery5161,avery5163,avery5167,avery5371}
  --digits DIGITS, -d DIGITS
                        Number of digits in the ASN (default: 7, produces 'ASN0000001')
  --border, -b          Display borders around labels, useful for debugging the printer alignment

Mandatory arguments

  • <start_asn>: The value of the first ASN to generate

Optional arguments

  • <output_file>: The name of the output file to write to (default: labels.pdf)
  • -h, --help: Shows the help message
  • -f, --format: Selects the format of the output sheet (see Supported Sheets)
  • -d, --digits: Specifies the number of digits in the ASN (e.g. for the default number 7, the ASN will look like 'ASN0000001')
  • -b, --border: Generates the borders around the labels to help debug alignment issues (see Tips & Tricks)

Supported Sheets

Some different sheet types are supported with the -f/--format argument, however, not all are tested.

The default is Avery L4731.

Currently tested and known working are:

  • Avery L4731 (DIN A4 Labels)

Tips & Tricks

In case your printer has alignment issues, you can generate a PDF with borders around the labels by using the -b/--border option.

License

paperless-asn-qr-codes is distributed under the terms of the GPL-3.0 license.