https://github.com/pibooth/pibooth-qrcode

Pibooth plugin to generate a QR code to access to the final the picture
https://github.com/pibooth/pibooth-qrcode

photo-booth photobooth plugin qrcode raspberry-pi raspberrypi

Last synced: 2 months ago
JSON representation

Pibooth plugin to generate a QR code to access to the final the picture

• Host: GitHub
• URL: https://github.com/pibooth/pibooth-qrcode
• Owner: pibooth
• License: gpl-3.0
• Created: 2020-04-24T19:41:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-10T10:12:28.000Z (over 1 year ago)
• Last Synced: 2024-11-01T07:41:07.231Z (2 months ago)
• Topics: photo-booth, photobooth, plugin, qrcode, raspberry-pi, raspberrypi
• Language: Python
• Homepage:
• Size: 1.86 MB
• Stars: 7
• Watchers: 4
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        

==============

pibooth-qrcode

==============

|PythonVersions| |PypiPackage| |Downloads|

``pibooth-qrcode`` is a plugin for the `pibooth`_ application.

It adds the display of a custom qrcode at the print and wait state

Install

-------

::

    $ pip3 install pibooth-qrcode

Configuration

-------------

Here below the new configuration options available in the `pibooth`_ configuration.

**The keys and their default values are automatically added to your configuration after first** `pibooth`_ **restart.**

.. code-block:: ini

    [QRCODE]

    # URL which may be composed of variables: {picture}, {count}

    prefix_url = https://github.com/pibooth/pibooth

    # Foreground color

    foreground = (255, 255, 255)

    # Background color

    background = (0, 0, 0)

    # Optional text displayed close to the QR code

    side_text =

    # Offset (x, y) from location

    offset = (20, 40)

    # Location on 'wait' state: topleft, topright, bottomleft, bottomright, midtop-left, midtop-right, midbottom-left, midbottom-right

    wait_location = bottomleft

    # Location on 'print' state: topleft, topright, bottomleft, bottomright, midtop-left, midtop-right, midbottom-left, midbottom-right

    print_location = bottomright

.. note:: Edit the configuration by running the command ``pibooth --config``.

QR code URL

-----------

The URL linked to the QR code can be define dynamically using some state variables or configuration

options. Available variables to forge the URL are:

- **picture** : current picture filename

- **count** : current counters. You can access to values using ``{count.xxx}`` (see counters

  in configuration menu)

- **url** : current picture URL as defined in ``app.previous_picture_url`` attribute (this attribute is

  generally defined by another plugin).

For instance, ``https://photos.google.com/share/AxFF4t56kiJiu89m/{picture}`` will generate::

    https://photos.google.com/share/AxFF4t56kiJiu89m/2021-06-11-10-14-08_pibooth.jpg

QR code locations

-----------------

Here is the possible QR code location at screen:

.. image:: https://raw.githubusercontent.com/pibooth/pibooth-qrcode/master/docs/images/locations.png

   :align: center

   :alt: Locations

Example

-------

Here is an example of the rendering you can get with this plugin on the wait screen:

.. image:: https://raw.githubusercontent.com/pibooth/pibooth-qrcode/master/docs/images/screenshot.png

   :align: center

   :alt: Example screenshot

.. --- Links ------------------------------------------------------------------

.. _`pibooth`: https://pypi.org/project/pibooth

.. |PythonVersions| image:: https://img.shields.io/badge/python-3.6+-red.svg

   :target: https://www.python.org/downloads

   :alt: Python 3.6+

.. |PypiPackage| image:: https://badge.fury.io/py/pibooth-qrcode.svg

   :target: https://pypi.org/project/pibooth-qrcode

   :alt: PyPi package

.. |Downloads| image:: https://img.shields.io/pypi/dm/pibooth-qrcode?color=purple

   :target: https://pypi.org/project/pibooth-qrcode

   :alt: PyPi downloads