Improve readme, and minor cleanup.

Author: HalfVoxel

README.md

@@ -2,16 +2,22 @@
 
 A GUI application for letting members log in on a public machine and interact with their data. It connects to a [makeradmin](https://github.com/makerspace/makeradmin) backend where the data resides. Memberbooth can perform the following:
 * Display current member status (lab membership end date)
-* Print labels for storage boxes (with QR code that can be scanned with [box-terminator](https://github.com/makerspace/BoxTerminator-App)) and labels for other temporary storage.
+* Print labels for storage boxes (with QR code that can be scanned with the box-terminator functionality built-in to makeradmin) and labels for other temporary storage.
 
 Optional Slack usage logging can be enabled.
 
+This is used at Stockholm Makerspace for their [memberbooth](https://wiki.makerspace.se/Memberbooth).
+
+<img src="./examples/ui.png" style="max-width:400px;">
+
 ## Prerequisites
 
-* You need to obtain a token from the makeradmin backend that has the correct permissions for accessing the "memberbooth" endpoints.
+- You need to obtain a token from the makeradmin backend that has the correct permissions for accessing the "memberbooth" endpoints. You can find it in the Settings page.
 
 ## Installation
 
+**Supported OS**: Linux (possibly works on mac and windows too, but not guaranteed)
+
 Install the `uv` package manager: https://docs.astral.sh/uv/getting-started/installation/
 
 ## Usage
@@ -28,9 +34,39 @@ If you want to run against a custom backend (e.g. for development purposes), the
 ### Logging in
 The memberbooth application is then logged in by running the *login.py* script. This script will log in to the backend and a optionally a slack notification system.
 
-### Printing labels for members
+### Printing labels from the command line
 *print_label.py* prints labels for members.
 
 ```bash
 uv run ./print_label.py <member_number> --no-printer --type=box
 ```
+
+## Types of labels
+
+Example label images can be found in the [examples directory](./examples):
+
+### Box label
+<img src="./examples/box_label.png" alt="Box label example" style="max-width:200px;">
+
+### Temporary storage label
+<img src="./examples/temp_storage_label.png" alt="Temporary storage label example" style="max-width:200px;">
+
+### Warning label
+<img src="./examples/warning_label.png" alt="Warning label example" style="max-width:200px;">
+
+### Name tag
+<img src="./examples/name_tag.png" alt="Name tag example" style="max-width:200px;">
+
+### Meetup label
+<img src="./examples/meetup_label.png" alt="Meetup label example" style="max-width:200px;">
+
+### 3D printer filament label
+<img src="./examples/3d_printer_filament_label.png" alt="3D printer filament label example" style="max-width:200px;">
+
+## Supported printers
+
+- [Brother QL 800](https://store.brother.se/catalogs/brothersweden/devices/label-printer/ql/ql800)
+- [Brother QL 800W](https://store.brother.se/catalogs/brothersweden/devices/label-printer/ql/ql810w)
+- Possibly more models in the Brother QL series
+
+Note that the "Editor Lite" mode must be *off* for it to work.

examples/3d_printer_filament_label.png

@@ -21,7 +21,7 @@
 def main() -> None:
     parser = argparse.ArgumentParser()
     group = parser.add_mutually_exclusive_group()
-    parser.add_argument("--type", choices=["box", "temp", "3d", "warning", "meetup"], default="name")
+    parser.add_argument("--type", choices=["box", "temp", "3d", "warning", "name", "meetup"], default="name")
     group.add_argument("-t", "--token_path", help="Path to Makeradmin token.", default=config.makeradmin_token_filename)
     group.add_argument("--development", action="store_true", help="Mock events")
     parser.add_argument("--no-backend", action="store_true", help="Mock backend (fake requests)")
@@ -92,7 +92,7 @@ def main() -> None:
             label = label_creator.create_label(uploaded_label)
 
             if ns.no_printer:
-                file_name = f'box_label_{member.member_number}_{str(int(time()))}.png'
+                file_name = f'{member.member_number}_{ns.type}_{str(int(time()))}.png'
                 logger.info(
                     f'Program run with --no-printer, storing label image to {file_name} instead of printing it.')
                 print(f"Saving box label to {file_name}")

examples/box_label.png

@@ -371,7 +371,7 @@ def create_warning_label(label: label_data.WarningLabel) -> Label:
     qr_code_wiki_link = create_qr_code(WIKI_LINK_MEMBER_STORAGE).make_image()
     labels: list[LabelObject] = [LabelImage(config.SMS_LOGOTYPE_PATH),
               LabelString(
-                  f'This project is, as of {datetime.today().date()}, violating our project marking rules. Unless corrected, the board may throw this away by {label.expires_at.strftime('%Y-%m-%d')}.',
+                  f'This project is, as of {label.base.created_at.date()}, violating our storage rules. Unless corrected, the board may throw this away by {label.expires_at.strftime('%Y-%m-%d')}.',
                   multiline=True),
               *([LabelString(label.description, multiline=True)] if label.description else []),
               LabelString("More info on the following web page:"),