Compare commits

..

1 commit

Author SHA1 Message Date
Markus Siebert 136662f4a4
Merge 55643c3051 into e51d579a83 2024-01-06 11:13:39 +01:00
3 changed files with 11 additions and 45 deletions

View file

@ -1,7 +1,7 @@
# 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 paperless with both a human readable representation, as well as a QR code
for machine consumption. The labels are Avery 4731 labels.
## Installation
@ -10,41 +10,10 @@ for machine consumption. The labels are Avery 4731 labels.
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}
--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](#supported-sheets))
- `-b`, `--border`: Generates the borders around the labels to help debug alignment issues (see [Tips & Tricks](#tips--tricks))
## Supported Sheets
Some different sheet types are supported with the `-f`/`--format` argument, however, not all are tested.
Some different sheet types are supported with the `--format` argument, however, not all are tested.
The default is Avery L4731.
Default is Avery L4731.
Currently tested and known working are:
- Avery L4731 (DIN A4 Labels)
@ -52,7 +21,7 @@ Currently tested and known working are:
## 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.
`--border` option.
## License

View file

@ -2,8 +2,7 @@ from dataclasses import dataclass, KW_ONLY
from collections.abc import Iterator
from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import LETTER, A4
from reportlab.lib.units import mm, inch
from reportlab.lib.units import mm
# Usage:
# label = AveryLabels.AveryLabel(5160)
@ -68,9 +67,9 @@ labelInfo: dict[str, LabelInfo] = {
"avery5167": LabelInfo(
labels_horizontal=4,
labels_vertical=20,
label_size=(1.75 * inch, 0.5 * inch),
gutter_size=(0.3 * inch, 0),
margin=(0.3 * inch, 0.5 * inch),
label_size=(126, 36),
gutter_size=(0, 0),
margin=(54, 36),
pagesize=LETTER,
),
# 3.5 x 2 business cards

View file

@ -2,7 +2,6 @@ import argparse
from reportlab.lib.units import mm
from reportlab_qrcode import QRCodeImage
from paperless_asn_qr_codes import avery_labels
@ -22,14 +21,13 @@ def main():
prog="paperless-asn-qr-codes",
description="CLI Tool for generating paperless ASN labels with QR codes",
)
parser.add_argument("start_asn", type=int, help="The value of the first ASN")
parser.add_argument("output_file", type=str, default="labels.pdf", help="The output file to write to (default: labels.pdf)")
parser.add_argument("start_asn")
parser.add_argument("output_file")
parser.add_argument(
"--format", "-f", choices=avery_labels.labelInfo.keys(), default="averyL4731"
"--format", choices=avery_labels.labelInfo.keys(), default="averyL4731"
)
parser.add_argument(
"--border",
"-b",
action="store_true",
help="Display borders around labels, useful for debugging the printer alignment",
)