qrbill 1.2.0
A library to generate Swiss QR-bill payment slips.
Requires Python: >=3.9

.. image:: https://github.com/claudep/swiss-qr-bill/actions/workflows/test.yml/badge.svg
   :alt: CI
   :target: https://github.com/claudep/swiss-qr-bill/actions/workflows/test.yml

.. image:: https://img.shields.io/pypi/v/qrbill.svg
   :target: https://pypi.python.org/pypi/qrbill/

Python library to generate Swiss QR-bills
=========================================

From 2020, Swiss payment slips will progressively be converted to the
QR-bill format.
Specifications can be found on https://www.paymentstandards.ch/

This library is aimed to produce properly-formatted QR-bills as SVG files
either from command line input or by using the ``QRBill`` class.

Installation
============

You can easily install this library with::

    $ pip install qrbill

Command line usage example
==========================

Minimal::

    $ qrbill --account "CH5800791123000889012" --creditor-name "John Doe"
      --creditor-postalcode 2501 --creditor-city "Biel"

More complete::

    $ qrbill --account "CH44 3199 9123 0008 8901 2" --reference-number "210000000003139471430009017"
    --creditor-name "Robert Schneider AG" --creditor-street "Rue du Lac 1268"
    --creditor-postalcode "2501" --creditor-city "Biel"
    --additional-information "Bill No. 3139 for garden work and disposal of cuttings."
    --debtor-name "Pia Rutschmann" --debtor-street "Marktgasse 28" --debtor-postalcode "9400"
    --debtor-city "Rorschach" --language "de"

For usage::

    $ qrbill -h

If no `--output` SVG file path is specified, the SVG file will be named after
the account and the current date/time and written in the current directory.

Note that if you don't like the automatic line wrapping in the human-readable
part of some address, you can replace a space by a newline sequence in the
creditor or debtor name, line1, line2, or street to force a line break in the
printed addresses.
(e.g. `--creditor-street "Rue des Quatorze Contours du Chemin\ndu Creux du Van"`)
The data encoded in the QR bill will *not* have the newline character. It will
be replaced by a regular space.

Python usage example
====================

::

    >>> from qrbill import QRBill
    >>> my_bill = QRBill(
            account='CH5800791123000889012',
            creditor={
                'name': 'Jane', 'pcode': '1000', 'city': 'Lausanne', 'country': 'CH',
            },
            amount='22.45',
        )
    >>> my_bill.as_svg('/tmp/my_bill.svg')

Outputting as PDF or bitmap
===========================

If you want to produce a PDF version of the resulting bill, we suggest using the
`svglib <https://pypi.org/project/svglib/>` library. It can be used on the
command line with the `svg2pdf` script, or directly from Python::

    >>> import tempfile
    >>> from qrbill import QRBill
    >>> from svglib.svglib import svg2rlg
    >>> from reportlab.graphics import renderPDF

    >>> my_bill = QRBill(
            account='CH5800791123000889012',
            creditor={
                'name': 'Jane', 'pcode': '1000', 'city': 'Lausanne', 'country': 'CH',
            },
            amount='22.45',
        )
    >>> with tempfile.TemporaryFile(encoding='utf-8', mode='r+') as temp:
    >>>     my_bill.as_svg(temp)
    >>>     temp.seek(0)
    >>>     drawing = svg2rlg(temp)
    >>> renderPDF.drawToFile(drawing, "file.pdf")

or to produce a bitmap image output::

    >>> from reportlab.graphics import renderPM
    >>> dpi = 300
    >>> drawing.scale(dpi/72, dpi/72)
    >>> renderPM.drawToFile(drawing, "file.png", fmt='PNG', dpi=dpi)

Running tests
=============

You can run tests by executing::

    $ PYTHONPATH=. python tests/test_qrbill.py


Sponsors
========

.. image:: https://seantis.ch/static/img/logo.svg
    :width: 150
    :target: https://seantis.ch/