pibooth-rclone-upload 1.5.0__tar.gz

pibooth_rclone_upload-1.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 peteoheat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pibooth_rclone_upload-1.5.0/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: pibooth-rclone-upload
+Version: 1.5.0
+Summary: Pibooth plugin that uploads pictures, GIFs, videos and QR codes to any rclone remote
+Author-email: peteoheat <peteoheat@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/peteoheat/pibooth-rclone-upload
+Project-URL: Issues, https://github.com/peteoheat/pibooth-rclone-upload/issues
+Keywords: pibooth,photobooth,raspberry-pi,rclone,upload,plugin
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Graphics :: Capture :: Digital Camera
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pibooth>=2.0.0
+Dynamic: license-file
+
+# pibooth-rclone-upload
+
+[![PyPI](https://img.shields.io/pypi/v/pibooth-rclone-upload)](https://pypi.org/project/pibooth-rclone-upload/)
+[![License: MIT](https://img.shields.io/pypi/l/pibooth-rclone-upload)](https://github.com/peteoheat/pibooth-rclone-upload/blob/main/LICENSE)
+
+A plugin for [pibooth](https://github.com/pibooth/pibooth) that automatically
+uploads captured photos, GIFs, videos, QR codes, and gallery metadata to any
+[rclone](https://rclone.org) remote. The benefit of using this plugin is that it
+makes your pibooth storage agnostic: you can upload your images to any storage
+supported by rclone.
+
+The plugin is designed for reliability, resumability, and unattended operation
+during photobooth events. It supports per-file uploads, bulk uploads, manifest
+tracking, QR code inclusion, and configurable timeouts. Uploads run in the
+background without blocking the booth UI.
+
+It is designed to work alongside my pibooth-qrcode and pibooth-gallery modules.
+
+## Pre-requisites
+
+This plugin depends on an existing [rclone](https://rclone.org) installation.
+
+Before using `pibooth-rclone-upload` you must:
+
+1. **Install rclone on your system in your preferred way**, for example:
+
+       sudo apt install rclone
+
+2. **Create and configure at least one rclone remote**, using:
+
+       rclone config
+
+   You must define a remote that the plugin can upload files to. The plugin does
+   not create or configure remotes automatically.
+
+If rclone is not installed or no remote is configured, uploads will fail.
+
+**Please test your rclone and remote from the command line before continuing
+with the plugin. If your remote doesn't work at the command line, it won't work
+from the plugin.**
+
+## Features
+
+- Uploads captured files to any rclone remote (S3, Cloudflare R2, Google Drive,
+  Dropbox, etc.)
+- Per-file uploads during booth operation
+- Optional bulk upload on exit
+- Manifest file to prevent duplicate uploads
+- Uploads gallery metadata (`thumbs.json` and `gallery.html`)
+- Optional QR code uploads with configurable suffix and extension
+- Threaded uploads to avoid blocking pibooth
+- Dry-run mode for safe testing
+- Customisable rclone arguments, timeouts, and file extensions
+
+## Installation
+
+Install into the same Python environment as pibooth:
+
+    pip install pibooth-rclone-upload
+
+pibooth finds installed plugins automatically through its `pibooth` entry point,
+so nothing needs to be added to the `plugins` option. The next time pibooth
+starts, the plugin is loaded.
+
+To upgrade:
+
+    pip install --upgrade pibooth-rclone-upload
+
+To remove it:
+
+    pip uninstall pibooth-rclone-upload
+
+### Raspberry Pi OS (Bookworm and Trixie)
+
+Recent Raspberry Pi OS releases mark the system Python as externally managed
+(PEP 668), so a bare `pip install` fails with `error: externally-managed-environment`.
+Do not work around this with `--break-system-packages`. Install the plugin into
+the same environment as pibooth instead:
+
+- **pibooth in a virtual environment** (recommended): use that environment's
+  `pip` directly, for example
+
+      ~/venv/bin/pip install pibooth-rclone-upload
+
+  or activate it first (`source ~/venv/bin/activate`).
+- **pibooth installed with pipx**:
+
+      pipx inject pibooth pibooth-rclone-upload
+
+- **pibooth installed with `--break-system-packages` or from apt**: the plugin
+  has to go in the same place. If you have not set up a virtual environment
+  yet, create one with `python3 -m venv --system-site-packages ~/venv`, install
+  both `pibooth` and `pibooth-rclone-upload` with `~/venv/bin/pip`, and run
+  pibooth from `~/venv/bin/pibooth`.
+
+Check where pibooth lives with `which pibooth`; the plugin must be installed
+into that environment.
+
+### Upgrading from a version before 1.5.0
+
+Earlier versions were a single file loaded through the `plugins` option of
+`[GENERAL]` in `pibooth.cfg`. After installing from PyPI, **remove the path to
+`pibooth-rclone-upload.py` from that option**, otherwise the plugin is loaded
+twice. The section in `pibooth.cfg` is now named `[RCLONE]` (it was `[RCLONE_UPLOAD]`): **rename the header of your existing section** to `[RCLONE]`, otherwise the old settings are ignored and an empty `[RCLONE]` section is added. The option names are unchanged.
+
+### Installing from source
+
+    git clone https://github.com/peteoheat/pibooth-rclone-upload
+    pip install ./pibooth-rclone-upload
+
+## Configuration
+
+The plugin automatically adds a `[RCLONE]` section (with default values)
+to your existing `pibooth.cfg` the first time it is loaded. Edit it with
+`pibooth --config` and restart pibooth.
+
+Two settings are **required** and have no default: `RCLONE_remote` and
+`RCLONE_bucket`. If either is missing, if no picture folder can be found, or if
+the remote is not known to rclone for the user running pibooth, an error naming
+the problem is logged and the plugin deactivates itself. pibooth keeps running.
+The settings are checked once at startup.
+
+All available configuration options are listed below.
+
+- `RCLONE_enabled` (bool, default: `True`): Enable or disable the plugin.
+
+- `RCLONE_remote` (str, **required**, no default): Name of the rclone remote, as shown by `rclone listremotes` (without the
+  trailing colon).
+
+- `RCLONE_bucket` (str, **required**, no default): Bucket or top-level directory on the remote.
+
+- `RCLONE_subdir` (str, default: empty): Optional subdirectory inside the bucket (e.g. an event name).
+
+- `RCLONE_local_path` (str, default: empty): Folder to upload from. Leave empty to use pibooth's `[GENERAL] directory`
+  (which may list several folders). A relative path is resolved against that
+  directory.
+
+- `RCLONE_rclone_args` (str, default: `--transfers=4 --checkers=8 --retries=3`): Additional rclone arguments, e.g.
+  `--config /home/pibooth/.config/rclone/rclone.conf` if pibooth runs as a
+  different user from the one who ran `rclone config`.
+
+- `RCLONE_dry_run` (bool, default: `False`): Log actions without uploading.
+
+- `RCLONE_file_extensions` (str, default: `.jpg,.jpeg,.png,.gif,.mp4,.json,.html`): Comma-separated list of file extensions to upload.
+
+- `RCLONE_upload_on_exit` (bool, default: `True`): Upload remaining files when pibooth exits.
+
+- `RCLONE_bulk_on_exit` (bool, default: `False`): Perform a single bulk `rclone copy` on exit.
+
+- `RCLONE_manifest_name` (str, default: `.rclone_uploaded_manifest.txt`): Manifest file (inside the picture folder) used to track uploaded files.
+
+- `RCLONE_timeout_per_file` (int, default: `120`): Timeout (seconds) for each file upload.
+
+- `RCLONE_timeout_bulk` (int, default: `300`): Timeout (seconds) for bulk upload.
+
+- `RCLONE_include_qrcodes` (bool, default: `True`): Upload QR code images.
+
+- `RCLONE_qrcode_suffix` (str, default: `_qrcode`): Suffix used to identify QR code files.
+
+- `RCLONE_qrcode_ext` (str, default: `.png`): File extension for QR code images.
+
+## Upload behaviour
+
+### During booth operation
+
+After each capture, the plugin:
+
+- Scans the output folder
+- Detects new files matching configured extensions (and QR codes)
+- Uploads them individually using `rclone copyto`
+- Records successful uploads in the manifest file
+- Always re-uploads `thumbs.json` and `gallery.html`, which change constantly,
+  and never records them in the manifest
+
+Uploads run in a background thread to avoid blocking the UI. Pictures
+"forgotten" on the print screen are moved out of the folder before the upload
+starts, so they are never uploaded.
+
+### On exit
+
+Two modes are available:
+
+**1. Bulk mode** (`RCLONE_bulk_on_exit = True`)
+
+    rclone copy <local_path>/ <remote>:<bucket>/<subdir>
+
+The `forget/` and `raw/` sub-folders and the manifest file are excluded.
+
+**2. Per-file mode** (default)
+
+Uploads any remaining files individually.
+
+## Manifest file
+
+The manifest file:
+
+- Prevents re-uploading files already sent
+- Lives inside the local output folder
+- Is appended to after each successful upload
+- Is created automatically if missing
+
+Deleting the manifest forces all files to be re-uploaded.
+
+## Dry run mode
+
+Enable:
+
+    RCLONE_dry_run = True
+
+This logs all upload commands without executing them. The manifest is never
+updated during a dry run.
+
+## Troubleshooting
+
+**The plugin is not loaded at all**
+
+- Make sure it is installed in the same Python environment that runs pibooth
+  (`pip show pibooth-rclone-upload`)
+- If you upgraded from a version before 1.5.0, remove the old path from
+  `[GENERAL] plugins`
+
+**Uploads not happening**
+
+- Ensure `RCLONE_enabled = True`
+- Confirm `rclone` is installed and in `PATH`
+- Verify the remote name using `rclone listremotes`, running it as the user that
+  runs pibooth
+- Check the pibooth log: a missing `RCLONE_remote` / `RCLONE_bucket` or an
+  unknown remote deactivates the plugin with an error message
+
+**Files not being detected**
+
+- Check `RCLONE_file_extensions`
+- Inspect the manifest file
+
+**QR codes not uploading**
+
+- Ensure `RCLONE_include_qrcodes = True`
+- Confirm suffix and extension match your QR generator
+
+**Bulk upload fails**
+
+- Increase `RCLONE_timeout_bulk`
+- Test manually:
+
+      rclone copy <local> <remote>
+
+## Example configuration
+
+    [RCLONE]
+    RCLONE_enabled = True
+    RCLONE_remote = pibooth-cloudflare
+    RCLONE_bucket = partyselfie
+    RCLONE_subdir = event-2025
+    RCLONE_local_path =
+    RCLONE_rclone_args = --transfers=4 --checkers=8 --retries=3
+    RCLONE_upload_on_exit = True
+    RCLONE_bulk_on_exit = False
+    RCLONE_include_qrcodes = True
+
+## Contributing
+
+Pull requests and feature suggestions are welcome at
+<https://github.com/peteoheat/pibooth-rclone-upload>.
+
+## License
+
+MIT License. See [LICENSE](LICENSE).

pibooth_rclone_upload-1.5.0/README.md

@@ -0,0 +1,268 @@
+# pibooth-rclone-upload
+
+[![PyPI](https://img.shields.io/pypi/v/pibooth-rclone-upload)](https://pypi.org/project/pibooth-rclone-upload/)
+[![License: MIT](https://img.shields.io/pypi/l/pibooth-rclone-upload)](https://github.com/peteoheat/pibooth-rclone-upload/blob/main/LICENSE)
+
+A plugin for [pibooth](https://github.com/pibooth/pibooth) that automatically
+uploads captured photos, GIFs, videos, QR codes, and gallery metadata to any
+[rclone](https://rclone.org) remote. The benefit of using this plugin is that it
+makes your pibooth storage agnostic: you can upload your images to any storage
+supported by rclone.
+
+The plugin is designed for reliability, resumability, and unattended operation
+during photobooth events. It supports per-file uploads, bulk uploads, manifest
+tracking, QR code inclusion, and configurable timeouts. Uploads run in the
+background without blocking the booth UI.
+
+It is designed to work alongside my pibooth-qrcode and pibooth-gallery modules.
+
+## Pre-requisites
+
+This plugin depends on an existing [rclone](https://rclone.org) installation.
+
+Before using `pibooth-rclone-upload` you must:
+
+1. **Install rclone on your system in your preferred way**, for example:
+
+       sudo apt install rclone
+
+2. **Create and configure at least one rclone remote**, using:
+
+       rclone config
+
+   You must define a remote that the plugin can upload files to. The plugin does
+   not create or configure remotes automatically.
+
+If rclone is not installed or no remote is configured, uploads will fail.
+
+**Please test your rclone and remote from the command line before continuing
+with the plugin. If your remote doesn't work at the command line, it won't work
+from the plugin.**
+
+## Features
+
+- Uploads captured files to any rclone remote (S3, Cloudflare R2, Google Drive,
+  Dropbox, etc.)
+- Per-file uploads during booth operation
+- Optional bulk upload on exit
+- Manifest file to prevent duplicate uploads
+- Uploads gallery metadata (`thumbs.json` and `gallery.html`)
+- Optional QR code uploads with configurable suffix and extension
+- Threaded uploads to avoid blocking pibooth
+- Dry-run mode for safe testing
+- Customisable rclone arguments, timeouts, and file extensions
+
+## Installation
+
+Install into the same Python environment as pibooth:
+
+    pip install pibooth-rclone-upload
+
+pibooth finds installed plugins automatically through its `pibooth` entry point,
+so nothing needs to be added to the `plugins` option. The next time pibooth
+starts, the plugin is loaded.
+
+To upgrade:
+
+    pip install --upgrade pibooth-rclone-upload
+
+To remove it:
+
+    pip uninstall pibooth-rclone-upload
+
+### Raspberry Pi OS (Bookworm and Trixie)
+
+Recent Raspberry Pi OS releases mark the system Python as externally managed
+(PEP 668), so a bare `pip install` fails with `error: externally-managed-environment`.
+Do not work around this with `--break-system-packages`. Install the plugin into
+the same environment as pibooth instead:
+
+- **pibooth in a virtual environment** (recommended): use that environment's
+  `pip` directly, for example
+
+      ~/venv/bin/pip install pibooth-rclone-upload
+
+  or activate it first (`source ~/venv/bin/activate`).
+- **pibooth installed with pipx**:
+
+      pipx inject pibooth pibooth-rclone-upload
+
+- **pibooth installed with `--break-system-packages` or from apt**: the plugin
+  has to go in the same place. If you have not set up a virtual environment
+  yet, create one with `python3 -m venv --system-site-packages ~/venv`, install
+  both `pibooth` and `pibooth-rclone-upload` with `~/venv/bin/pip`, and run
+  pibooth from `~/venv/bin/pibooth`.
+
+Check where pibooth lives with `which pibooth`; the plugin must be installed
+into that environment.
+
+### Upgrading from a version before 1.5.0
+
+Earlier versions were a single file loaded through the `plugins` option of
+`[GENERAL]` in `pibooth.cfg`. After installing from PyPI, **remove the path to
+`pibooth-rclone-upload.py` from that option**, otherwise the plugin is loaded
+twice. The section in `pibooth.cfg` is now named `[RCLONE]` (it was `[RCLONE_UPLOAD]`): **rename the header of your existing section** to `[RCLONE]`, otherwise the old settings are ignored and an empty `[RCLONE]` section is added. The option names are unchanged.
+
+### Installing from source
+
+    git clone https://github.com/peteoheat/pibooth-rclone-upload
+    pip install ./pibooth-rclone-upload
+
+## Configuration
+
+The plugin automatically adds a `[RCLONE]` section (with default values)
+to your existing `pibooth.cfg` the first time it is loaded. Edit it with
+`pibooth --config` and restart pibooth.
+
+Two settings are **required** and have no default: `RCLONE_remote` and
+`RCLONE_bucket`. If either is missing, if no picture folder can be found, or if
+the remote is not known to rclone for the user running pibooth, an error naming
+the problem is logged and the plugin deactivates itself. pibooth keeps running.
+The settings are checked once at startup.
+
+All available configuration options are listed below.
+
+- `RCLONE_enabled` (bool, default: `True`): Enable or disable the plugin.
+
+- `RCLONE_remote` (str, **required**, no default): Name of the rclone remote, as shown by `rclone listremotes` (without the
+  trailing colon).
+
+- `RCLONE_bucket` (str, **required**, no default): Bucket or top-level directory on the remote.
+
+- `RCLONE_subdir` (str, default: empty): Optional subdirectory inside the bucket (e.g. an event name).
+
+- `RCLONE_local_path` (str, default: empty): Folder to upload from. Leave empty to use pibooth's `[GENERAL] directory`
+  (which may list several folders). A relative path is resolved against that
+  directory.
+
+- `RCLONE_rclone_args` (str, default: `--transfers=4 --checkers=8 --retries=3`): Additional rclone arguments, e.g.
+  `--config /home/pibooth/.config/rclone/rclone.conf` if pibooth runs as a
+  different user from the one who ran `rclone config`.
+
+- `RCLONE_dry_run` (bool, default: `False`): Log actions without uploading.
+
+- `RCLONE_file_extensions` (str, default: `.jpg,.jpeg,.png,.gif,.mp4,.json,.html`): Comma-separated list of file extensions to upload.
+
+- `RCLONE_upload_on_exit` (bool, default: `True`): Upload remaining files when pibooth exits.
+
+- `RCLONE_bulk_on_exit` (bool, default: `False`): Perform a single bulk `rclone copy` on exit.
+
+- `RCLONE_manifest_name` (str, default: `.rclone_uploaded_manifest.txt`): Manifest file (inside the picture folder) used to track uploaded files.
+
+- `RCLONE_timeout_per_file` (int, default: `120`): Timeout (seconds) for each file upload.
+
+- `RCLONE_timeout_bulk` (int, default: `300`): Timeout (seconds) for bulk upload.
+
+- `RCLONE_include_qrcodes` (bool, default: `True`): Upload QR code images.
+
+- `RCLONE_qrcode_suffix` (str, default: `_qrcode`): Suffix used to identify QR code files.
+
+- `RCLONE_qrcode_ext` (str, default: `.png`): File extension for QR code images.
+
+## Upload behaviour
+
+### During booth operation
+
+After each capture, the plugin:
+
+- Scans the output folder
+- Detects new files matching configured extensions (and QR codes)
+- Uploads them individually using `rclone copyto`
+- Records successful uploads in the manifest file
+- Always re-uploads `thumbs.json` and `gallery.html`, which change constantly,
+  and never records them in the manifest
+
+Uploads run in a background thread to avoid blocking the UI. Pictures
+"forgotten" on the print screen are moved out of the folder before the upload
+starts, so they are never uploaded.
+
+### On exit
+
+Two modes are available:
+
+**1. Bulk mode** (`RCLONE_bulk_on_exit = True`)
+
+    rclone copy <local_path>/ <remote>:<bucket>/<subdir>
+
+The `forget/` and `raw/` sub-folders and the manifest file are excluded.
+
+**2. Per-file mode** (default)
+
+Uploads any remaining files individually.
+
+## Manifest file
+
+The manifest file:
+
+- Prevents re-uploading files already sent
+- Lives inside the local output folder
+- Is appended to after each successful upload
+- Is created automatically if missing
+
+Deleting the manifest forces all files to be re-uploaded.
+
+## Dry run mode
+
+Enable:
+
+    RCLONE_dry_run = True
+
+This logs all upload commands without executing them. The manifest is never
+updated during a dry run.
+
+## Troubleshooting
+
+**The plugin is not loaded at all**
+
+- Make sure it is installed in the same Python environment that runs pibooth
+  (`pip show pibooth-rclone-upload`)
+- If you upgraded from a version before 1.5.0, remove the old path from
+  `[GENERAL] plugins`
+
+**Uploads not happening**
+
+- Ensure `RCLONE_enabled = True`
+- Confirm `rclone` is installed and in `PATH`
+- Verify the remote name using `rclone listremotes`, running it as the user that
+  runs pibooth
+- Check the pibooth log: a missing `RCLONE_remote` / `RCLONE_bucket` or an
+  unknown remote deactivates the plugin with an error message
+
+**Files not being detected**
+
+- Check `RCLONE_file_extensions`
+- Inspect the manifest file
+
+**QR codes not uploading**
+
+- Ensure `RCLONE_include_qrcodes = True`
+- Confirm suffix and extension match your QR generator
+
+**Bulk upload fails**
+
+- Increase `RCLONE_timeout_bulk`
+- Test manually:
+
+      rclone copy <local> <remote>
+
+## Example configuration
+
+    [RCLONE]
+    RCLONE_enabled = True
+    RCLONE_remote = pibooth-cloudflare
+    RCLONE_bucket = partyselfie
+    RCLONE_subdir = event-2025
+    RCLONE_local_path =
+    RCLONE_rclone_args = --transfers=4 --checkers=8 --retries=3
+    RCLONE_upload_on_exit = True
+    RCLONE_bulk_on_exit = False
+    RCLONE_include_qrcodes = True
+
+## Contributing
+
+Pull requests and feature suggestions are welcome at
+<https://github.com/peteoheat/pibooth-rclone-upload>.
+
+## License
+
+MIT License. See [LICENSE](LICENSE).

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.egg-info/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: pibooth-rclone-upload
+Version: 1.5.0
+Summary: Pibooth plugin that uploads pictures, GIFs, videos and QR codes to any rclone remote
+Author-email: peteoheat <peteoheat@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/peteoheat/pibooth-rclone-upload
+Project-URL: Issues, https://github.com/peteoheat/pibooth-rclone-upload/issues
+Keywords: pibooth,photobooth,raspberry-pi,rclone,upload,plugin
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Graphics :: Capture :: Digital Camera
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pibooth>=2.0.0
+Dynamic: license-file
+
+# pibooth-rclone-upload
+
+[![PyPI](https://img.shields.io/pypi/v/pibooth-rclone-upload)](https://pypi.org/project/pibooth-rclone-upload/)
+[![License: MIT](https://img.shields.io/pypi/l/pibooth-rclone-upload)](https://github.com/peteoheat/pibooth-rclone-upload/blob/main/LICENSE)
+
+A plugin for [pibooth](https://github.com/pibooth/pibooth) that automatically
+uploads captured photos, GIFs, videos, QR codes, and gallery metadata to any
+[rclone](https://rclone.org) remote. The benefit of using this plugin is that it
+makes your pibooth storage agnostic: you can upload your images to any storage
+supported by rclone.
+
+The plugin is designed for reliability, resumability, and unattended operation
+during photobooth events. It supports per-file uploads, bulk uploads, manifest
+tracking, QR code inclusion, and configurable timeouts. Uploads run in the
+background without blocking the booth UI.
+
+It is designed to work alongside my pibooth-qrcode and pibooth-gallery modules.
+
+## Pre-requisites
+
+This plugin depends on an existing [rclone](https://rclone.org) installation.
+
+Before using `pibooth-rclone-upload` you must:
+
+1. **Install rclone on your system in your preferred way**, for example:
+
+       sudo apt install rclone
+
+2. **Create and configure at least one rclone remote**, using:
+
+       rclone config
+
+   You must define a remote that the plugin can upload files to. The plugin does
+   not create or configure remotes automatically.
+
+If rclone is not installed or no remote is configured, uploads will fail.
+
+**Please test your rclone and remote from the command line before continuing
+with the plugin. If your remote doesn't work at the command line, it won't work
+from the plugin.**
+
+## Features
+
+- Uploads captured files to any rclone remote (S3, Cloudflare R2, Google Drive,
+  Dropbox, etc.)
+- Per-file uploads during booth operation
+- Optional bulk upload on exit
+- Manifest file to prevent duplicate uploads
+- Uploads gallery metadata (`thumbs.json` and `gallery.html`)
+- Optional QR code uploads with configurable suffix and extension
+- Threaded uploads to avoid blocking pibooth
+- Dry-run mode for safe testing
+- Customisable rclone arguments, timeouts, and file extensions
+
+## Installation
+
+Install into the same Python environment as pibooth:
+
+    pip install pibooth-rclone-upload
+
+pibooth finds installed plugins automatically through its `pibooth` entry point,
+so nothing needs to be added to the `plugins` option. The next time pibooth
+starts, the plugin is loaded.
+
+To upgrade:
+
+    pip install --upgrade pibooth-rclone-upload
+
+To remove it:
+
+    pip uninstall pibooth-rclone-upload
+
+### Raspberry Pi OS (Bookworm and Trixie)
+
+Recent Raspberry Pi OS releases mark the system Python as externally managed
+(PEP 668), so a bare `pip install` fails with `error: externally-managed-environment`.
+Do not work around this with `--break-system-packages`. Install the plugin into
+the same environment as pibooth instead:
+
+- **pibooth in a virtual environment** (recommended): use that environment's
+  `pip` directly, for example
+
+      ~/venv/bin/pip install pibooth-rclone-upload
+
+  or activate it first (`source ~/venv/bin/activate`).
+- **pibooth installed with pipx**:
+
+      pipx inject pibooth pibooth-rclone-upload
+
+- **pibooth installed with `--break-system-packages` or from apt**: the plugin
+  has to go in the same place. If you have not set up a virtual environment
+  yet, create one with `python3 -m venv --system-site-packages ~/venv`, install
+  both `pibooth` and `pibooth-rclone-upload` with `~/venv/bin/pip`, and run
+  pibooth from `~/venv/bin/pibooth`.
+
+Check where pibooth lives with `which pibooth`; the plugin must be installed
+into that environment.
+
+### Upgrading from a version before 1.5.0
+
+Earlier versions were a single file loaded through the `plugins` option of
+`[GENERAL]` in `pibooth.cfg`. After installing from PyPI, **remove the path to
+`pibooth-rclone-upload.py` from that option**, otherwise the plugin is loaded
+twice. The section in `pibooth.cfg` is now named `[RCLONE]` (it was `[RCLONE_UPLOAD]`): **rename the header of your existing section** to `[RCLONE]`, otherwise the old settings are ignored and an empty `[RCLONE]` section is added. The option names are unchanged.
+
+### Installing from source
+
+    git clone https://github.com/peteoheat/pibooth-rclone-upload
+    pip install ./pibooth-rclone-upload
+
+## Configuration
+
+The plugin automatically adds a `[RCLONE]` section (with default values)
+to your existing `pibooth.cfg` the first time it is loaded. Edit it with
+`pibooth --config` and restart pibooth.
+
+Two settings are **required** and have no default: `RCLONE_remote` and
+`RCLONE_bucket`. If either is missing, if no picture folder can be found, or if
+the remote is not known to rclone for the user running pibooth, an error naming
+the problem is logged and the plugin deactivates itself. pibooth keeps running.
+The settings are checked once at startup.
+
+All available configuration options are listed below.
+
+- `RCLONE_enabled` (bool, default: `True`): Enable or disable the plugin.
+
+- `RCLONE_remote` (str, **required**, no default): Name of the rclone remote, as shown by `rclone listremotes` (without the
+  trailing colon).
+
+- `RCLONE_bucket` (str, **required**, no default): Bucket or top-level directory on the remote.
+
+- `RCLONE_subdir` (str, default: empty): Optional subdirectory inside the bucket (e.g. an event name).
+
+- `RCLONE_local_path` (str, default: empty): Folder to upload from. Leave empty to use pibooth's `[GENERAL] directory`
+  (which may list several folders). A relative path is resolved against that
+  directory.
+
+- `RCLONE_rclone_args` (str, default: `--transfers=4 --checkers=8 --retries=3`): Additional rclone arguments, e.g.
+  `--config /home/pibooth/.config/rclone/rclone.conf` if pibooth runs as a
+  different user from the one who ran `rclone config`.
+
+- `RCLONE_dry_run` (bool, default: `False`): Log actions without uploading.
+
+- `RCLONE_file_extensions` (str, default: `.jpg,.jpeg,.png,.gif,.mp4,.json,.html`): Comma-separated list of file extensions to upload.
+
+- `RCLONE_upload_on_exit` (bool, default: `True`): Upload remaining files when pibooth exits.
+
+- `RCLONE_bulk_on_exit` (bool, default: `False`): Perform a single bulk `rclone copy` on exit.
+
+- `RCLONE_manifest_name` (str, default: `.rclone_uploaded_manifest.txt`): Manifest file (inside the picture folder) used to track uploaded files.
+
+- `RCLONE_timeout_per_file` (int, default: `120`): Timeout (seconds) for each file upload.
+
+- `RCLONE_timeout_bulk` (int, default: `300`): Timeout (seconds) for bulk upload.
+
+- `RCLONE_include_qrcodes` (bool, default: `True`): Upload QR code images.
+
+- `RCLONE_qrcode_suffix` (str, default: `_qrcode`): Suffix used to identify QR code files.
+
+- `RCLONE_qrcode_ext` (str, default: `.png`): File extension for QR code images.
+
+## Upload behaviour
+
+### During booth operation
+
+After each capture, the plugin:
+
+- Scans the output folder
+- Detects new files matching configured extensions (and QR codes)
+- Uploads them individually using `rclone copyto`
+- Records successful uploads in the manifest file
+- Always re-uploads `thumbs.json` and `gallery.html`, which change constantly,
+  and never records them in the manifest
+
+Uploads run in a background thread to avoid blocking the UI. Pictures
+"forgotten" on the print screen are moved out of the folder before the upload
+starts, so they are never uploaded.
+
+### On exit
+
+Two modes are available:
+
+**1. Bulk mode** (`RCLONE_bulk_on_exit = True`)
+
+    rclone copy <local_path>/ <remote>:<bucket>/<subdir>
+
+The `forget/` and `raw/` sub-folders and the manifest file are excluded.
+
+**2. Per-file mode** (default)
+
+Uploads any remaining files individually.
+
+## Manifest file
+
+The manifest file:
+
+- Prevents re-uploading files already sent
+- Lives inside the local output folder
+- Is appended to after each successful upload
+- Is created automatically if missing
+
+Deleting the manifest forces all files to be re-uploaded.
+
+## Dry run mode
+
+Enable:
+
+    RCLONE_dry_run = True
+
+This logs all upload commands without executing them. The manifest is never
+updated during a dry run.
+
+## Troubleshooting
+
+**The plugin is not loaded at all**
+
+- Make sure it is installed in the same Python environment that runs pibooth
+  (`pip show pibooth-rclone-upload`)
+- If you upgraded from a version before 1.5.0, remove the old path from
+  `[GENERAL] plugins`
+
+**Uploads not happening**
+
+- Ensure `RCLONE_enabled = True`
+- Confirm `rclone` is installed and in `PATH`
+- Verify the remote name using `rclone listremotes`, running it as the user that
+  runs pibooth
+- Check the pibooth log: a missing `RCLONE_remote` / `RCLONE_bucket` or an
+  unknown remote deactivates the plugin with an error message
+
+**Files not being detected**
+
+- Check `RCLONE_file_extensions`
+- Inspect the manifest file
+
+**QR codes not uploading**
+
+- Ensure `RCLONE_include_qrcodes = True`
+- Confirm suffix and extension match your QR generator
+
+**Bulk upload fails**
+
+- Increase `RCLONE_timeout_bulk`
+- Test manually:
+
+      rclone copy <local> <remote>
+
+## Example configuration
+
+    [RCLONE]
+    RCLONE_enabled = True
+    RCLONE_remote = pibooth-cloudflare
+    RCLONE_bucket = partyselfie
+    RCLONE_subdir = event-2025
+    RCLONE_local_path =
+    RCLONE_rclone_args = --transfers=4 --checkers=8 --retries=3
+    RCLONE_upload_on_exit = True
+    RCLONE_bulk_on_exit = False
+    RCLONE_include_qrcodes = True
+
+## Contributing
+
+Pull requests and feature suggestions are welcome at
+<https://github.com/peteoheat/pibooth-rclone-upload>.
+
+## License
+
+MIT License. See [LICENSE](LICENSE).

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pibooth_rclone_upload.py
+pyproject.toml
+pibooth_rclone_upload.egg-info/PKG-INFO
+pibooth_rclone_upload.egg-info/SOURCES.txt
+pibooth_rclone_upload.egg-info/dependency_links.txt
+pibooth_rclone_upload.egg-info/entry_points.txt
+pibooth_rclone_upload.egg-info/requires.txt
+pibooth_rclone_upload.egg-info/top_level.txt

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pibooth]
+pibooth_rclone_upload = pibooth_rclone_upload

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.egg-info/requires.txt

@@ -0,0 +1 @@
+pibooth>=2.0.0

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.egg-info/top_level.txt

@@ -0,0 +1 @@
+pibooth_rclone_upload

pibooth_rclone_upload-1.5.0/pibooth_rclone_upload.py

@@ -0,0 +1,433 @@
+"""
+pibooth_rclone_upload
+
+PiBooth plugin that uploads captured pictures to an rclone remote.
+Written against pibooth 2.1.0.
+
+Configuration
+-------------
+The options live in the [RCLONE] section of pibooth.cfg. That section is
+created automatically the first time the plugin is loaded (see
+``_ensure_config_section``). Two settings are required and have no default:
+
+    RCLONE_remote   rclone remote name (see 'rclone listremotes')
+    RCLONE_bucket   bucket / top-level folder on that remote
+
+If a required setting is missing, or the remote is not known to rclone for the
+user running pibooth, an error naming the offending setting is logged and the
+plugin deactivates itself. pibooth itself keeps running.
+"""
+
+__version__ = "1.5.0"
+
+import io
+import os
+import shlex
+import shutil
+import subprocess
+import threading
+from pathlib import Path
+from typing import List, Optional
+
+import pibooth
+from pibooth.utils import LOGGER
+
+SECTION = "RCLONE"
+RCLONE_MANIFEST = ".rclone_uploaded_manifest.txt"
+
+# Files that change over time: re-uploaded on every run, never put in the manifest.
+SIDECAR_FILES = ("thumbs.json", "gallery.html")
+
+# Only one rclone job at a time (per-picture uploads vs. the exit upload).
+_upload_lock = threading.Lock()
+
+# (option, default, description, menu label, menu choices)
+# A menu label makes the option editable in pibooth's Settings menu; None hides it.
+# menu choices: a list gives a selector, a string gives a text input.
+OPTIONS = [
+    ("RCLONE_enabled", True, "Enable uploading pictures with rclone",
+     "Upload with rclone", ["True", "False"]),
+    ("RCLONE_remote", "", "Required: rclone remote name, as shown by 'rclone listremotes' (without the colon)",
+     "Remote name", ""),
+    ("RCLONE_bucket", "", "Required: bucket / top-level folder on the remote",
+     "Bucket name", ""),
+    ("RCLONE_subdir", "", "(Optional) Sub-folder inside the bucket (ex: 'some-event-name')",
+     "Sub-folder (optional)", ""),
+    ("RCLONE_local_path", "", "Folder to upload from. Leave empty to use pibooth's [GENERAL] directory. "
+                              "A relative path is resolved against that directory",
+     None, None),
+    ("RCLONE_rclone_args", "--transfers=4 --checkers=8 --retries=3",
+     "Extra rclone arguments (ex: --config /home/pibooth/.config/rclone/rclone.conf)",
+     None, None),
+    ("RCLONE_dry_run", False, "Only log the rclone commands, do not run them",
+     "Dry run (log only)", ["True", "False"]),
+    ("RCLONE_file_extensions", ".jpg,.jpeg,.png,.gif,.mp4,.json,.html",
+     "Comma separated file extensions to upload", None, None),
+    ("RCLONE_upload_on_exit", True, "Upload anything still pending when pibooth exits", None, None),
+    ("RCLONE_bulk_on_exit", False,
+     "On exit, run one 'rclone copy' of the whole folder instead of per-file uploads", None, None),
+    ("RCLONE_manifest_name", RCLONE_MANIFEST,
+     "File (inside the picture folder) that records uploaded files", None, None),
+    ("RCLONE_timeout_per_file", 120, "Timeout in seconds for a single file upload", None, None),
+    ("RCLONE_timeout_bulk", 300, "Timeout in seconds for the bulk copy on exit", None, None),
+    ("RCLONE_include_qrcodes", True, "Also upload QR code images", None, None),
+    ("RCLONE_qrcode_suffix", "_qrcode", "QR code file name suffix (before the extension)", None, None),
+    ("RCLONE_qrcode_ext", ".png", "QR code file extension", None, None),
+]
+
+_DEFAULTS = {name: default for name, default, _d, _m, _c in OPTIONS}
+
+
+# --------------------------------------------------------------------------- #
+# Configuration
+# --------------------------------------------------------------------------- #
+
+def _ensure_config_section(cfg):
+    """Create the plugin section in an existing pibooth.cfg if it is missing.
+
+    pibooth only writes plugin options into pibooth.cfg on its very first launch
+    or when the Settings menu is saved, so a plugin installed later would never
+    appear in the file. Append the section (defaults only) so it can be edited
+    with 'pibooth --config'. Nothing else in the file is touched.
+    """
+    filename = getattr(cfg, "filename", None)
+    if not filename or not os.path.isfile(filename):
+        return  # first pibooth launch: pibooth generates the whole file itself
+    if cfg.has_section(SECTION):
+        return
+    try:
+        with io.open(filename, "a", encoding="utf-8") as fp:
+            fp.write("\n[{}]\n".format(SECTION))
+            for name, default, description, _menu, _choices in OPTIONS:
+                fp.write("# {}\n{} = {}\n\n".format(description, name, default))
+    except OSError as exc:
+        LOGGER.warning("rclone: could not add the [%s] section to '%s': %s", SECTION, filename, exc)
+        return
+    LOGGER.info("rclone: added the [%s] section to '%s'. Set RCLONE_remote and RCLONE_bucket, "
+                "then restart pibooth", SECTION, filename)
+
+
+@pibooth.hookimpl
+def pibooth_configure(cfg):
+    """Declare the plugin options and make sure they are present in pibooth.cfg.
+
+    PiConfigParser.add_option signature is:
+        add_option(section, option, default, description, menu_name=None, menu_choices=None)
+    """
+    for name, default, description, menu_name, menu_choices in OPTIONS:
+        cfg.add_option(SECTION, name, default, description, menu_name, menu_choices)
+    _ensure_config_section(cfg)
+
+
+def _get_str(cfg, name: str) -> str:
+    return cfg.get(SECTION, name).strip().strip('"').strip()
+
+
+def _get_bool(cfg, name: str) -> bool:
+    raw = _get_str(cfg, name).lower()
+    if raw in ("true", "yes", "on", "1"):
+        return True
+    if raw in ("false", "no", "off", "0"):
+        return False
+    LOGGER.warning("rclone: invalid value '%s' for [%s][%s] (expected True/False), using %s",
+                   raw, SECTION, name, _DEFAULTS[name])
+    return bool(_DEFAULTS[name])
+
+
+def _get_int(cfg, name: str) -> int:
+    raw = _get_str(cfg, name)
+    try:
+        value = int(raw)
+        if value <= 0:
+            raise ValueError(raw)
+        return value
+    except ValueError:
+        LOGGER.warning("rclone: invalid value '%s' for [%s][%s] (expected a positive number), using %s",
+                       raw, SECTION, name, _DEFAULTS[name])
+        return int(_DEFAULTS[name])
+
+
+def _resolve_folders(cfg, local_path: str) -> List[Path]:
+    """Work out which folder(s) to upload from.
+
+    pibooth has no ``app.directory`` / ``app.output_dir`` attribute: the picture
+    folder(s) come from the [GENERAL] ``directory`` option, which can hold
+    several paths, hence ``gettuple``.
+    """
+    pibooth_dirs = [Path(p).expanduser().absolute()
+                    for p in cfg.gettuple("GENERAL", "directory", "path") if p]
+
+    local_path = local_path.strip()
+    if not local_path:
+        return pibooth_dirs
+
+    lp = Path(local_path).expanduser()
+    if lp.is_absolute():
+        return [lp]
+    if pibooth_dirs:
+        return [d / lp for d in pibooth_dirs]
+    return [Path.home() / lp]
+
+
+def _read_settings(cfg) -> dict:
+    """Read every option. Bad optional values fall back to their default."""
+    args_raw = _get_str(cfg, "RCLONE_rclone_args")
+    try:
+        args = shlex.split(args_raw)
+    except ValueError as exc:
+        LOGGER.warning("rclone: cannot parse [%s][RCLONE_rclone_args] (%s), using the default", SECTION, exc)
+        args = shlex.split(_DEFAULTS["RCLONE_rclone_args"])
+
+    try:
+        folders = _resolve_folders(cfg, _get_str(cfg, "RCLONE_local_path"))
+    except Exception as exc:
+        LOGGER.warning("rclone: cannot determine the picture folder: %s", exc)
+        folders = []
+
+    return {
+        "enabled": _get_bool(cfg, "RCLONE_enabled"),
+        "remote": _get_str(cfg, "RCLONE_remote").rstrip(":"),
+        "bucket": _get_str(cfg, "RCLONE_bucket"),
+        "subdir": _get_str(cfg, "RCLONE_subdir"),
+        "folders": folders,
+        "args": args,
+        "dry_run": _get_bool(cfg, "RCLONE_dry_run"),
+        "extensions": [x.strip().lower()
+                       for x in _get_str(cfg, "RCLONE_file_extensions").split(",") if x.strip()],
+        "upload_on_exit": _get_bool(cfg, "RCLONE_upload_on_exit"),
+        "bulk_on_exit": _get_bool(cfg, "RCLONE_bulk_on_exit"),
+        "manifest_name": _get_str(cfg, "RCLONE_manifest_name") or RCLONE_MANIFEST,
+        "timeout_per_file": _get_int(cfg, "RCLONE_timeout_per_file"),
+        "timeout_bulk": _get_int(cfg, "RCLONE_timeout_bulk"),
+        "include_qrcodes": _get_bool(cfg, "RCLONE_include_qrcodes"),
+        "qrcode_suffix": _get_str(cfg, "RCLONE_qrcode_suffix"),
+        "qrcode_ext": _get_str(cfg, "RCLONE_qrcode_ext").lower(),
+    }
+
+
+def _missing_settings(settings: dict) -> List[str]:
+    """Describe every required setting that is not filled in."""
+    problems = []
+    if not settings["remote"]:
+        problems.append("rclone remote not defined in [{}][RCLONE_remote]".format(SECTION))
+    if not settings["bucket"]:
+        problems.append("bucket name not defined in [{}][RCLONE_bucket]".format(SECTION))
+    if not settings["folders"]:
+        problems.append("no picture folder found: check [GENERAL][directory] "
+                        "or [{}][RCLONE_local_path]".format(SECTION))
+    return problems
+
+
+def _check_rclone(settings: dict) -> Optional[str]:
+    """Return a description of what is wrong with rclone or the remote, or None if usable."""
+    if shutil.which("rclone") is None:
+        return "'rclone' executable not found in PATH"
+    try:
+        result = subprocess.run(["rclone"] + settings["args"] + ["listremotes"],
+                                stdout=subprocess.PIPE, stderr=subprocess.PIPE, timeout=15)
+    except subprocess.TimeoutExpired:
+        return "'rclone listremotes' timed out"
+    except OSError as exc:
+        return "cannot run rclone: {}".format(exc)
+    if result.returncode != 0:
+        return "'rclone listremotes' failed: {}".format(result.stderr.decode(errors="replace").strip())
+
+    remotes = {line.strip().rstrip(":") for line in result.stdout.decode(errors="replace").splitlines()
+               if line.strip()}
+    if settings["remote"] not in remotes:
+        return ("remote '{}' from [{}][RCLONE_remote] is not in the rclone config of the user running "
+                "pibooth (remotes found: {}). Run 'rclone listremotes' and 'rclone config file' as that "
+                "user, or pass --config in [{}][RCLONE_rclone_args]".format(
+                    settings["remote"], SECTION, ", ".join(sorted(remotes)) or "none", SECTION))
+    return None
+
+
+@pibooth.hookimpl
+def pibooth_startup(cfg, app):
+    """Validate the configuration once and keep it on the app object.
+
+    Never raise from here: an exception in pibooth_startup takes the whole
+    photobooth down, so on any problem the plugin just deactivates itself.
+    """
+    app.rclone_cfg = {"enabled": False}
+    try:
+        settings = _read_settings(cfg)
+        if not settings["enabled"]:
+            LOGGER.info("rclone: uploading disabled in [%s][RCLONE_enabled]", SECTION)
+            return
+
+        problems = _missing_settings(settings)
+        if not problems:
+            rclone_problem = _check_rclone(settings)
+            if rclone_problem:
+                problems.append(rclone_problem)
+        if problems:
+            for problem in problems:
+                LOGGER.error("rclone: %s, uploading deactivated", problem)
+            return
+    except Exception as exc:
+        LOGGER.error("rclone: unexpected error while reading the configuration, uploading deactivated: %s", exc)
+        return
+
+    app.rclone_cfg = settings
+    LOGGER.info("rclone: uploading %s -> %s", ", ".join(str(f) for f in settings["folders"]), _dest(settings))
+
+
+# --------------------------------------------------------------------------- #
+# Helpers
+# --------------------------------------------------------------------------- #
+
+def _dest(settings: dict) -> str:
+    parts = [p.strip("/") for p in (settings["bucket"], settings["subdir"]) if p.strip("/")]
+    return f"{settings['remote']}:" + "/".join(parts)
+
+
+def _read_manifest(path: Path) -> set:
+    try:
+        return set(path.read_text().splitlines()) if path.exists() else set()
+    except Exception:
+        return set()
+
+
+def _append_manifest(path: Path, name: str):
+    try:
+        path.parent.mkdir(parents=True, exist_ok=True)
+        with path.open("a") as f:
+            f.write(name + "\n")
+    except Exception:
+        LOGGER.warning("rclone: failed to update manifest %s", path)
+
+
+def _mtime(path: Path) -> float:
+    try:
+        return path.stat().st_mtime
+    except OSError:  # file moved meanwhile (e.g. picture "forgotten")
+        return 0.0
+
+
+def _run_rclone_copyto(src: Path, dest: str, args: List[str], dry_run: bool, timeout: int) -> bool:
+    full_dest = f"{dest.rstrip('/')}/{src.name}"
+    cmd = ["rclone"] + args + ["copyto", str(src), full_dest]
+    if dry_run:
+        LOGGER.info("rclone: dry-run: %s", " ".join(shlex.quote(a) for a in cmd))
+        return True
+    try:
+        result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, timeout=timeout)
+        if result.returncode == 0:
+            LOGGER.info("rclone: uploaded %s", src.name)
+            return True
+        LOGGER.warning("rclone: failed to upload %s: %s", src.name, result.stderr.decode(errors="replace").strip())
+        return False
+    except Exception as exc:
+        LOGGER.warning("rclone: exception uploading %s: %s", src.name, exc)
+        return False
+
+
+def _upload_folder(folder: Path, settings: dict):
+    if not folder.is_dir():
+        LOGGER.warning("rclone: local path does not exist: %s", folder)
+        return
+
+    dest = _dest(settings)
+    manifest = folder / settings["manifest_name"]
+    uploaded = _read_manifest(manifest)
+    skip = set(SIDECAR_FILES) | {settings["manifest_name"]}
+
+    files = sorted((f for f in folder.glob("*") if f.is_file()), key=_mtime)
+
+    qr_tail = (settings["qrcode_suffix"] + settings["qrcode_ext"]).lower()
+    candidates = []
+    for f in files:
+        if f.name in skip or f.name in uploaded:
+            continue
+        is_qrcode = settings["include_qrcodes"] and f.name.lower().endswith(qr_tail)
+        if f.suffix.lower() in settings["extensions"] or is_qrcode:
+            candidates.append(f)
+
+    # Gallery helper files change constantly, so always push the latest copy.
+    for name in SIDECAR_FILES:
+        f = folder / name
+        if f.exists():
+            _run_rclone_copyto(f, dest, settings["args"], settings["dry_run"], settings["timeout_per_file"])
+
+    for f in candidates:
+        ok = _run_rclone_copyto(f, dest, settings["args"], settings["dry_run"], settings["timeout_per_file"])
+        # A dry run must not mark files as uploaded.
+        if ok and not settings["dry_run"]:
+            _append_manifest(manifest, f.name)
+
+
+def _upload_files(app, reason: str):
+    settings = getattr(app, "rclone_cfg", None)
+    if not settings or not settings.get("enabled"):
+        return
+    with _upload_lock:
+        LOGGER.debug("rclone: upload pass (%s)", reason)
+        for folder in settings["folders"]:
+            try:
+                _upload_folder(folder, settings)
+            except Exception as exc:
+                LOGGER.warning("rclone: upload pass failed for %s: %s", folder, exc)
+
+
+def _bulk_copy(settings: dict):
+    dest = _dest(settings)
+    with _upload_lock:
+        for folder in settings["folders"]:
+            if not folder.is_dir():
+                LOGGER.warning("rclone: local path does not exist: %s", folder)
+                continue
+            cmd = (["rclone"] + settings["args"] + ["copy", f"{folder}/", dest,
+                   # never publish "forgotten" pictures, raw captures or the manifest
+                   "--exclude", "/forget/**",
+                   "--exclude", "/raw/**",
+                   "--exclude", f"/{settings['manifest_name']}"])
+            if settings["dry_run"]:
+                LOGGER.info("rclone: dry-run bulk copy: %s", " ".join(shlex.quote(a) for a in cmd))
+                continue
+            try:
+                result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+                                        timeout=settings["timeout_bulk"])
+                if result.returncode == 0:
+                    LOGGER.info("rclone: bulk copy of %s complete", folder)
+                else:
+                    LOGGER.warning("rclone: bulk copy of %s failed: %s", folder,
+                                   result.stderr.decode(errors="replace").strip())
+            except Exception as exc:
+                LOGGER.warning("rclone: bulk copy of %s failed: %s", folder, exc)
+
+
+# --------------------------------------------------------------------------- #
+# Hooks
+# --------------------------------------------------------------------------- #
+
+@pibooth.hookimpl
+def state_finish_enter(app):
+    """Upload in the background once a picture has been kept.
+
+    'finish' is entered after the 'print' state, where the user can "forget" a
+    picture (it is moved to the 'forget' sub-folder). By the time we get here a
+    forgotten picture is no longer in the folder, so it is never uploaded.
+    """
+    if not getattr(app, "rclone_cfg", {}).get("enabled"):
+        return
+    threading.Thread(target=_upload_files, args=(app, "capture"), daemon=True).start()
+
+
+@pibooth.hookimpl
+def pibooth_cleanup(app):
+    """Final upload on exit.
+
+    Runs synchronously: a daemon thread would be killed as soon as the
+    interpreter exits, cutting the upload short.
+    """
+    settings = getattr(app, "rclone_cfg", None)
+    if not settings or not settings.get("enabled") or not settings.get("upload_on_exit"):
+        return
+    try:
+        if settings["bulk_on_exit"]:
+            _bulk_copy(settings)
+        else:
+            _upload_files(app, "exit")
+    except Exception as exc:
+        LOGGER.warning("rclone: exit upload failed: %s", exc)

pibooth_rclone_upload-1.5.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pibooth-rclone-upload"
+dynamic = ["version"]
+description = "Pibooth plugin that uploads pictures, GIFs, videos and QR codes to any rclone remote"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "peteoheat", email = "peteoheat@gmail.com" }]
+keywords = ["pibooth", "photobooth", "raspberry-pi", "rclone", "upload", "plugin"]
+dependencies = ["pibooth>=2.0.0"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Other Environment",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Multimedia :: Graphics :: Capture :: Digital Camera",
+]
+
+[project.urls]
+Homepage = "https://github.com/peteoheat/pibooth-rclone-upload"
+Issues = "https://github.com/peteoheat/pibooth-rclone-upload/issues"
+
+# pibooth discovers installed plugins through this entry point group.
+[project.entry-points.pibooth]
+pibooth_rclone_upload = "pibooth_rclone_upload"
+
+[tool.setuptools]
+py-modules = ["pibooth_rclone_upload"]
+
+[tool.setuptools.dynamic]
+version = { attr = "pibooth_rclone_upload.__version__" }

pibooth_rclone_upload-1.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+