dinbrief 0.5.0__py3-none-any.whl

dinbrief/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.4.0'

dinbrief/contrib/form.py

@@ -0,0 +1,112 @@
+
+from decimal import Decimal
+from xml.sax.saxutils import escape
+
+from reportlab.lib import colors
+from reportlab.lib.units import mm, cm
+from reportlab.platypus import Paragraph
+from reportlab.platypus import Spacer
+from reportlab.platypus.tables import Table
+from reportlab.platypus.tables import TableStyle
+
+from ..optional_django import gettext as _
+from ..styles import styles
+
+
+class FlowableProxy(object):
+
+    def __getattr__(self, name):
+        return getattr(self.flowable, name)
+
+
+class Field(FlowableProxy):
+    field_height = 5*mm
+
+    def __init__(self, label, field_height=None, value=None):
+        if field_height is not None:
+            self.field_height = field_height
+        self.flowable = Table(
+            data=[
+                [value or ''], # empty row for the text
+                [Paragraph(label, styles['FieldLabel'])],
+            ],
+            colWidths=[80*mm],
+            rowHeights=[self.field_height, None],
+            style=TableStyle([
+                ('NOSPLIT', (0, 0), (-1, -1)),
+                ('TOPPADDING', (0, 0), (-1, -1), 0),
+                ('RIGHTPADDING', (0, 0), (-1, -1), 0),
+                ('BOTTOMPADDING', (0, 0), (-1, -1), 0),
+                ('LEFTPADDING', (0, 0), (-1, -1), 0),
+                ('LINEBELOW', (0, 0), (0, 0), 0.2*mm, colors.black),
+                #('TOPPADDING', (0, 0), (0, 0), 5*mm),
+            ]),
+            hAlign='LEFT'
+        )
+
+
+class SignatureField(Field):
+    field_height = 15*mm
+
+    def __init__(self, label=None, field_height=None, value=None):
+        if label is None:
+            label = _('Place, date and signature')
+        super(SignatureField, self).__init__(label, field_height, value)
+
+
+class TwoSignaturesField(FlowableProxy):
+    field_height = 15*mm
+
+    def __init__(self, label_left, label_right, field_height=None,
+            value_left=None, value_right=None):
+        if field_height is not None:
+            self.field_height = field_height
+        self.flowable = Table(
+            data=[
+                [value_left or '', '', value_right or ''], # empty row for the text
+                [
+                    Paragraph(label_left, styles['FieldLabel']),
+                    '',
+                    Paragraph(label_right, styles['FieldLabel']),
+                ],
+            ],
+            colWidths=[80*mm, 10*mm, 80*mm],
+            rowHeights=[self.field_height, None],
+            style=TableStyle([
+                ('NOSPLIT', (0, 0), (-1, -1)),
+                ('TOPPADDING', (0, 0), (-1, -1), 0),
+                ('RIGHTPADDING', (0, 0), (-1, -1), 0),
+                ('BOTTOMPADDING', (0, 0), (-1, -1), 0),
+                ('LEFTPADDING', (0, 0), (-1, -1), 0),
+                ('LINEBELOW', (0, 0), (0, 0), 0.2*mm, colors.black),
+                ('LINEBELOW', (2, 0), (2, 0), 0.2*mm, colors.black),
+            ]),
+            hAlign='LEFT'
+        )
+
+
+class PostalCodeAndCityField(FlowableProxy):
+    field_height = 5*mm
+    def __init__(self):
+        self.flowable = Table(
+            data=[
+                ['', '', ''], # empty row for the text
+                [
+                    Paragraph(_('Postal code'), styles['FieldLabel']),
+                    '', # Space between postal code and city
+                    Paragraph(_('City'), styles['FieldLabel']),
+                ],
+            ],
+            colWidths=[20*mm, 5*mm, 55*mm],
+            rowHeights=[self.field_height, None],
+            style=TableStyle([
+                ('NOSPLIT', (0, 0), (-1, -1)),
+                ('TOPPADDING', (0, 0), (-1, -1), 0),
+                ('RIGHTPADDING', (0, 0), (-1, -1), 0),
+                ('BOTTOMPADDING', (0, 0), (-1, -1), 0),
+                ('LEFTPADDING', (0, 0), (-1, -1), 0),
+                ('LINEBELOW', (0, 0), (0, 0), 0.2*mm, colors.black),
+                ('LINEBELOW', (2, 0), (2, 0), 0.2*mm, colors.black),
+            ]),
+            hAlign='LEFT'
+        )

dinbrief/contrib/qrcode.py

@@ -0,0 +1,72 @@
+from __future__ import absolute_import
+
+try:
+    from io import BytesIO
+except ImportError:
+    from StringIO import StringIO as BytesIO
+
+import qrcode
+from reportlab.platypus.flowables import Image
+
+from ..styles import styles
+
+
+def qrcode_image(data):
+    # create QRCode object
+    code = qrcode.QRCode(
+            box_size=1,
+            border=0,
+            error_correction=qrcode.constants.ERROR_CORRECT_M)
+    code.add_data(data)
+    code.make()
+    # render QRCode as PNG into memory
+    img = code.make_image()
+    img_data = BytesIO()
+    img.save(img_data, 'PNG')
+    img_data.seek(0)
+    img_data.__repr__ = lambda: 'qrcode.png'
+    # create image floatable
+    return Image(img_data)
+
+
+def sepa_credit_transfer(account_holder, iban, bic, amount, reference,
+        purpose='', currency='EUR'):
+    '''
+    Create QRCode object according to EPC069-12:
+    http://www.europeanpaymentscouncil.eu/knowledge_bank_detail.cfm?documents_id=607
+    A list of purpose options can be found online:
+    http://www.hettwer-beratung.de/sepa-spezialwissen/sepa-technische-anforderungen/sepa-purpose-codes-vs-dta-textschl%C3%BCssel/
+    '''
+    assert 1 <= len(account_holder) < 70
+    assert len(currency) == 3
+    assert len(bic) in (8, 11)
+    assert ' ' not in bic
+    assert 1 <= len(iban) <= 34
+    assert ' ' not in iban
+    assert len(purpose) <= 4
+    assert len(reference) <= 35
+    return qrcode_image('\n'.join((
+        # Service Tag
+        'BCD',
+        # Version
+        '001',
+        # Character set (1=utf-8)
+        '1',
+        # identification code
+        'SCT',
+        # BIC
+        bic,
+        # name
+        account_holder,
+        # IBAN
+        iban,
+        # Amount
+        '%s%.2f' % (currency, amount),
+        # Purpose
+        purpose,
+        # Reference
+        reference,
+        # Unstructured Remittance Information
+        '',
+        # Beneficiary to originator information
+        '')))

dinbrief/contrib/simple.py

@@ -0,0 +1,15 @@
+from functools import partial
+
+from reportlab.lib.units import mm
+from reportlab.platypus import Paragraph
+from reportlab.platypus import Spacer
+
+from ..styles import styles
+
+
+P = partial(Paragraph, style=styles['Text'])
+H2 = partial(Paragraph, style=styles['H2'])
+Subject = partial(Paragraph, style=styles['Subject'])
+SmallSpacer = partial(Spacer, width=0, height=5*mm)
+MediumSpacer = partial(Spacer, width=0, height=10*mm)
+LargeSpacer = partial(Spacer, width=0, height=20*mm)

dinbrief/document.py

@@ -0,0 +1,26 @@
+class Document(object):
+
+    title = ''
+    subject = ''
+    author = ''
+    keywords = None
+    creator = 'http://pypi.python.org/pypi/dinbrief'
+
+    sender = None
+    recipient = None
+    content = None
+    date = ''
+
+    def __init__(self, **kwargs):
+        # Metadata
+        self.title = kwargs.pop('title', self.title)
+        self.subject = kwargs.pop('subject', self.subject)
+        self.author = kwargs.pop('author', self.author)
+        self.keywords = kwargs.pop('keywords', self.keywords)
+        self.creator = kwargs.pop('creator', self.creator)
+        # Content
+        self.sender = kwargs.pop('sender', self.sender or [])
+        self.recipient = kwargs.pop('recipient', self.recipient or [])
+        self.infobox = kwargs.pop('infobox', [])
+        self.date = kwargs.pop('date', self.date)
+        self.content = kwargs.pop('content', self.content or [])

dinbrief/invoice/__init__.py

@@ -0,0 +1,5 @@
+from .invoice import Invoice
+from .item import Item
+from .item_table import ItemTable
+from .total_table import TotalTable
+from .bank_transfer_form import BankTransferForm

dinbrief/invoice/bank_transfer_form.py

@@ -0,0 +1,90 @@
+from decimal import Decimal
+from xml.sax.saxutils import escape
+
+from reportlab.lib import colors
+from reportlab.lib.units import mm, cm
+from reportlab.platypus import Paragraph
+from reportlab.platypus import Spacer
+from reportlab.platypus.tables import Table
+from reportlab.platypus.tables import TableStyle
+
+from ..optional_django import gettext as _
+from ..optional_django import number_format
+from ..styles import styles
+
+
+def BankTransferForm(account_holder, iban, bic, reference, amount,
+        currency=u'EUR', currency_label=u'€', show_qrcode=False):
+
+    col_widths = [40*mm, 60*mm]
+    row_heights = [7*mm, 6*mm, 6*mm, 6*mm, 7*mm]
+
+    table_style = []
+
+    if show_qrcode:
+        from ..contrib import qrcode
+        table_style += [
+            ('SPAN', (2, 0), (2, 4)),
+        ]
+        qrcode_size = sum(row_heights) - 4*mm
+        col_widths += [qrcode_size + 4*mm]
+        qrcode_image = qrcode.sepa_credit_transfer(
+            account_holder=account_holder,
+            iban=''.join(iban.split()),
+            bic=''.join(bic.split()),
+            reference=reference,
+            amount=amount,
+            currency=currency)
+        qrcode_image.drawWidth = qrcode_size
+        qrcode_image.drawHeight = qrcode_size
+
+    table_style += [
+        ('ALIGN', (0, 0), (-1, -1), 'LEFT'),
+        ('VALIGN', (0, 0), (-1, -1), 'TOP'),
+        ('TOPPADDING', (0, 0), (-1, -1), 1*mm),
+        ('RIGHTPADDING', (0, 0), (-1, -1), 2*mm),
+        ('BOTTOMPADDING', (0, 0), (-1, -1), 1*mm),
+        ('LEFTPADDING', (0, 0), (-1, -1), 2*mm),
+        ('NOSPLIT', (0, 0), (-1, -1)),
+        # right
+        ('RIGHTPADDING', (-1, 0), (-1, -1), 2*mm),
+        ('LINEAFTER', (-1, 0), (-1, -1), 0.2*mm, colors.black),
+        # left
+        ('LEFTPADDING', (0, 0), (0, -1), 2*mm),
+        ('LINEBEFORE', (0, 0), (0, -1), 0.2*mm, colors.black),
+        # top
+        ('TOPPADDING', (0, 0), (-1, 0), 2*mm),
+        ('LINEABOVE', (0, 0), (-1, 0), 0.2*mm, colors.black),
+        # bottom
+        ('BOTTOMPADDING', (0, -1), (-1, -1), 3*mm),
+        ('LINEBELOW', (0, -1), (-1, -1), 0.2*mm, colors.black),
+    ]
+
+    def data_generator():
+        yield (
+            Paragraph(_(u'Account holder') + ':', styles['TableCell']),
+            Paragraph(account_holder, styles['TableCell'])
+        ) + ((qrcode_image,) if show_qrcode else ())
+        yield (
+            Paragraph(_(u'IBAN') + ':', styles['TableCell']),
+            Paragraph(iban, styles['TableCell']),
+        )
+        yield (
+            Paragraph(_(u'BIC') + ':', styles['TableCell']),
+            Paragraph(bic, styles['TableCell']),
+        )
+        yield (
+            Paragraph(_(u'Amount') + ':', styles['TableCell']),
+            Paragraph(u'%s %s' % (number_format(amount, 2), currency_label), styles['TableCell']),
+        )
+        yield (
+            Paragraph(_(u'Reference') + ':', styles['TableCell']),
+            Paragraph(reference, styles['TableCell']),
+        )
+
+    return Table(
+        data=list(data_generator()),
+        colWidths=col_widths,
+        rowHeights=row_heights,
+        style=TableStyle(table_style),
+        hAlign='LEFT')

dinbrief/invoice/invoice.py

@@ -0,0 +1,34 @@
+from decimal import Decimal
+
+from .vat_item import VatItem
+
+
+class Invoice(object):
+
+    def __init__(self, items=None, currency=u'€'):
+        self.items = items or []
+        self.currency = currency
+        self.vat_items = []
+        self.recalculate()
+
+    def recalculate(self):
+        self.vat_items = []
+        d = {}
+        for item in self.items:
+            if not item.vat_rate:
+                continue
+            try:
+                vat_item = d[item.vat_rate]
+            except KeyError:
+                vat_item = VatItem(rate=item.vat_rate)
+                d[item.vat_rate] = vat_item
+            vat_item.amount += item.vat_rate * item.subtotal
+        self.vat_items = sorted(d.values(), key=lambda item: item.rate)
+
+    @property
+    def gross(self):
+        return self.net + sum(vat_item.amount for vat_item in self.vat_items)
+
+    @property
+    def net(self):
+        return sum(item.total for item in self.items)

dinbrief/invoice/item.py

@@ -0,0 +1,35 @@
+from decimal import Decimal
+
+
+class Item(object):
+
+    def __init__(self, position=0, text='', period='', date=None,
+            price=Decimal(0), unit='', quantity=Decimal(1),
+            discount=Decimal(0), vat_rate=Decimal(0),
+            type='item'):
+        self.position = position
+        self.text = text
+        self.period = period
+        self.date = date
+        self.price = price
+        self.unit = unit
+        self.quantity = quantity
+        self.discount = discount
+        self.vat_rate = vat_rate
+        self.type = type
+
+    @property
+    def subtotal(self):
+        return self.price * self.quantity
+
+    @property
+    def discount_percentage(self):
+        return self.discount * 100
+
+    @property
+    def discount_amount(self):
+        return self.discount * self.subtotal
+
+    @property
+    def total(self):
+        return self.subtotal - self.discount_amount

dinbrief/invoice/item_table.py

@@ -0,0 +1,124 @@
+from decimal import Decimal
+from functools import partial
+from xml.sax.saxutils import escape
+
+from reportlab.lib import colors
+from reportlab.lib.units import mm, cm
+from reportlab.platypus import Paragraph
+from reportlab.platypus.tables import Table
+from reportlab.platypus.tables import TableStyle
+
+from ..optional_django import gettext as _
+from ..optional_django import number_format
+from ..optional_django import date_format
+from ..styles import styles
+
+
+Head = partial(Paragraph, style=styles['TableHead'])
+HeadRight = partial(Paragraph, style=styles['TableHeadRight'])
+Cell = partial(Paragraph, style=styles['TableCell'])
+Number = partial(Paragraph, style=styles['TableNumber'])
+Title = partial(Paragraph, style=styles['TableTitle'])
+
+title_bgcolor = colors.CMYKColor(black=0.1)
+
+
+def ItemTable(brief_template, invoice):
+
+    style = [
+        ('VALIGN', (0, 0), (-1,  0), 'BOTTOM'),
+        ('VALIGN', (0, 1), (-1, -1), 'TOP'),
+        ('LINEBELOW', (0, 0), (-1, 0), 0.3*mm, colors.black),
+        #('LINEBELOW', (0, 1), (-1, -1), 0.1*mm, colors.black),
+        ('TOPPADDING', (0, 0), (-1, -1), 2*mm),
+        ('RIGHTPADDING', (0, 0), (-1, -1), 2*mm),
+        ('BOTTOMPADDING', (0, 0), (-1, -1), 3*mm),
+        ('LEFTPADDING', (0, 0), (-1, -1), 2*mm),
+        # no padding on the far left and far right
+        ('LEFTPADDING', (0, 0), (0, -1), 0),
+        ('RIGHTPADDING', (-1, 0), (-1, -1), 0),
+        # no padding between net price and unit
+        ('RIGHTPADDING', (3, 0), (3, -1), 0),
+        ('LEFTPADDING', (4, 0), (4, -1), 0),
+    ]
+
+    show_period_column = any(item.period for item in invoice.items)
+    show_date_column = any(item.date for item in invoice.items) and \
+            not show_period_column
+
+    col_widths = [
+            8*mm, # position
+            0,    # description
+            46*mm if show_period_column else # period
+            24*mm if show_date_column else # date
+            0, # neither period nor date
+            21*mm, # unit price
+            13*mm, # unit
+            20*mm, # quantity
+            26*mm  # sum price
+    ]
+    col_widths[1] = brief_template.CONTENT_WIDTH - sum(col_widths)
+
+    def data_generator():
+        # header
+        yield (
+            HeadRight(u'#'),
+            Head(_('Description')),
+            Head(_('Period') if show_period_column else
+                 _('Date') if show_date_column else ''),
+            HeadRight(_('Unit Price')),
+            Head(u''),
+            HeadRight(_('Quantity')),
+            HeadRight(_('Line Total')),
+        )
+        # items
+        row = 0
+        for item in invoice.items:
+            row += 1
+            item_type = getattr(item, 'type', 'item')
+            if item_type == 'item':
+                if not (item.period or item.date):
+                    style.append(('SPAN', (1, row), (2, row)))
+                yield (
+                    Number(u'%s' % item.position),
+                    Cell(escape(item.text)),
+                    Cell(escape(item.period) if item.period else
+                         escape(date_format(item.date, 'SHORT_DATE_FORMAT')) if item.date else u''),
+                    Number(u'%s €' % number_format(item.price, 2)),
+                    Cell((u'/%s' % escape(item.unit))
+                        if item.unit else u''),
+                    Number(number_format(item.quantity, 2)),
+                    Number(u'%s €' % number_format(item.subtotal, 2)),
+                )
+                if item.discount:
+                    row += 1
+                    percentage = number_format(item.discount_percentage)
+                    yield (
+                        Cell(u''),
+                        Cell((u'%s%% ' % percentage) + _('discount')),
+                        Cell(u''),
+                        Cell(u''),
+                        Cell(u''),
+                        Cell(u''),
+                        Number(u'–%s €' % number_format(item.discount_amount, 2)),
+                    )
+                    style.append(('TOPPADDING', (0, row), (-1, row), 0))
+                # draw line below item
+                style.append(('LINEBELOW', (0, row), (-1, row),
+                    0.1*mm, colors.black))
+            elif item_type == 'title':
+                style.append(('SPAN', (1, row), (6, row)))
+                style.append(('BACKGROUND', (0, row), (-1, row),
+                        title_bgcolor))
+                style.append(('LINEBELOW', (0, row), (-1, row),
+                        0.1*mm, colors.black))
+                yield (
+                    Number(u'%s' % item.position),
+                    Title(escape(item.text)),
+                )
+
+    return Table(
+        data=list(data_generator()),
+        colWidths=col_widths,
+        style=TableStyle(style),
+        repeatRows=1)

dinbrief/invoice/total_table.py

@@ -0,0 +1,90 @@
+from decimal import Decimal
+from xml.sax.saxutils import escape
+
+from reportlab.lib import colors
+from reportlab.lib.units import mm, cm
+from reportlab.platypus import Paragraph
+from reportlab.platypus import Spacer
+from reportlab.platypus.tables import Table
+from reportlab.platypus.tables import TableStyle
+
+from ..optional_django import gettext as _
+from ..optional_django import number_format
+from ..styles import styles
+
+
+def TotalTable(brief_template, invoice):
+
+    table_style = [
+        ('ALIGN', (0, 0), (-1, -1), 'LEFT'),
+        ('TOPPADDING', (0, 0), (-1, -1), 1*mm),
+        ('RIGHTPADDING', (0, 0), (-1, -1), 2*mm),
+        ('BOTTOMPADDING', (0, 0), (-1, -1), 1*mm),
+        ('LEFTPADDING', (0, 0), (-1, -1), 2*mm),
+        # no padding on the far left and far right
+        ('LEFTPADDING', (0, 0), (0, -1), 0),
+        ('RIGHTPADDING', (-1, 0), (-1, -1), 0),
+    ]
+
+    col_widths = [0, 32*mm, 24*mm]
+    col_widths[0] = brief_template.CONTENT_WIDTH - sum(col_widths)
+
+    if invoice.vat_items:
+        net_row = 0
+        vat_row = net_row+1
+        gross_row = vat_row + len(invoice.vat_items)
+        table_style += [
+            ('BOTTOMPADDING', (0, gross_row-1), (-1, gross_row-1), 2*mm),
+            #('TOPPADDING', (0, vat_row), (-1, gross_row), 1*mm),
+            #('BOTTOMPADDING', (0, vat_row), (-1, gross_row), 1*mm),
+            ('LINEABOVE', (0, net_row), (-1, net_row), 0.3*mm, colors.black),
+            ('LINEABOVE', (1, gross_row), (-1, gross_row), 0.3*mm, colors.black),
+        ]
+        def data_generator():
+            yield (
+                Paragraph(u'', styles['TableCell']),
+                Paragraph(_(u'Sum (net)'), styles['TableCell']),
+                Paragraph(u'%s €' % number_format(invoice.net, 2),
+                    styles['TableNumber']),
+            )
+            for vat_item in invoice.vat_items:
+                yield (
+                    Paragraph(u'', styles['TableCell']),
+                    Paragraph((u'+%s%% ' % number_format(vat_item.rate * 100)) +
+                        _('VAT'), styles['TableCell']),
+                    Paragraph(u'%s €' % number_format(vat_item.amount, 2),
+                        styles['TableNumber']),
+                )
+            yield (
+                Paragraph(u'', styles['TableCell']),
+                Paragraph(_(u'Sum (gross)'), styles['GrossTableCell']),
+                Paragraph(u'%s €' % number_format(invoice.gross, 2),
+                    styles['GrossValueTableCell']),
+            )
+    else:
+        net_row = 0
+        gross_row = 1
+        table_style += [
+            ('TOPPADDING', (0, net_row), (-1, net_row), 2*mm),
+            ('BOTTOMPADDING', (0, net_row), (-1, net_row), 0),
+            ('LINEABOVE', (0, net_row), (-1, net_row), 0.3*mm, colors.black),
+            ('TOPPADDING', (0, gross_row), (-1, gross_row), 2*mm),
+            ('LINEABOVE', (1, gross_row), (-1, gross_row), 0.3*mm, colors.black),
+        ]
+        def data_generator():
+            yield (
+                Spacer(0, 0),
+                Spacer(0, 0),
+                Spacer(0, 0),
+            )
+            yield (
+                Paragraph(u'', styles['TableCell']),
+                Paragraph(_(u'Sum (net)'), styles['GrossTableCell']),
+                Paragraph(u'%s €' % number_format(invoice.gross, 2),
+                    styles['GrossValueTableCell']),
+            )
+
+    return Table(
+        data=list(data_generator()),
+        colWidths=col_widths,
+        style=TableStyle(table_style))

dinbrief/invoice/vat_item.py

@@ -0,0 +1,7 @@
+from decimal import Decimal
+
+
+class VatItem(object):
+    def __init__(self, rate, amount=Decimal(0)):
+        self.rate = rate
+        self.amount = amount