Merge 55643c3051 into 278046ae90

Add documentation for the command line arguments and options

README.md

@@ -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,10 +10,41 @@ for machine consumption. The labels are Avery 4731 labels.
 pip install paperless-asn-qr-codes
 ```
 
-## Supported Sheets
+## Usage
-Some different sheet types are supported with the `--format` argument, however, not all are tested.
 
-Default is Avery L4731.
+```
+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.
+
+The default is Avery L4731.
 
 Currently tested and known working are:
 - Avery L4731 (DIN A4 Labels)
@@ -21,7 +52,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
-`--border` option.
+`-b`/`--border` option.
 
 ## License
 

paperless_asn_qr_codes/avery_labels.py

@@ -2,7 +2,8 @@ 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
+from reportlab.lib.units import mm, inch
+
 
 # Usage:
 #   label = AveryLabels.AveryLabel(5160)
@@ -67,9 +68,9 @@ labelInfo: dict[str, LabelInfo] = {
     "avery5167": LabelInfo(
         labels_horizontal=4,
         labels_vertical=20,
-        label_size=(126, 36),
+        label_size=(1.75 * inch, 0.5 * inch),
-        gutter_size=(0, 0),
+        gutter_size=(0.3 * inch, 0),
-        margin=(54, 36),
+        margin=(0.3 * inch, 0.5 * inch),
         pagesize=LETTER,
     ),
     # 3.5 x 2 business cards

paperless_asn_qr_codes/main.py

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