latex_invoices.py File Reference

Exports an invoice to lco-file for use with LaTeX, see Python invoice export. More...

Go to the source code of this file.

Data Structures
class	latex_invoices.Usage

Functions
def	latex_invoices.invoice_to_lco (invoice)
def	latex_invoices.main (argv=None)

Detailed Description

Exports an invoice to lco-file for use with LaTeX, see Python invoice export.

Author

Christoph Holtermann (c.holtermann (at) gmx.de)

Date

May 2011

The output file can be imported into KOMA-Script-letters. This works primarily for germany. Internationalization welcome!

Additional files:

• Invoice.tex
  Example template file. Should be modified according to personal needs.
• rechnung.sty
  style file for invoices.
  This file is not part of the python-bindings!
  For an example where to get it see section credits below.

Usage :

latex_invoice -l -f -n INVOICE_NUMBER file://testfile 

will create file data.lco.

latex --output-format=pdf Invoice.tex 

should run latex on file Invoice.tex and result in Invoice.pdf. Invoice.tex includes data.lco.

Additional information :

• Doxygen docs: see page Python invoice export at https://code.gnucash.org/docs/MAINT or MASTER
• https://www.uweziegenhagen.de/latex/documents/rechnung/rechnungen.pdf (german)

Credits to and ideas from

• Main function as proposed by Guido van Rossum at https://www.artima.com/weblogs/viewpost.jsp?thread=4829
• Invoice.tex is derived from
  scrlttr2.tex v0.3. (c) by Juergen Fenn juerg.nosp@m.en.f.nosp@m.enn@g.nosp@m.mx.d.nosp@m.e
  https://www.komascript.de/node/355
  english translation: ftp://ftp.dante.de/tex-archive/info/templates/fenn/scrlttr2en.tex
• rechnung.sty
  from M G Berberich (berbe.nosp@m.ric@.nosp@m.fmi.u.nosp@m.ni-p.nosp@m.assau.nosp@m..de) and Ulrich Sibiller (uli42.nosp@m.@web.nosp@m..de) Ver3.10 from https://www.forwiss.uni-passau.de/~berberic/TeX/Rechnung/index.html

To Do:

• get own contact data from gnucash
• have own bank information in footline
• nicer formatting of invoice date and date due
• is there anything else missing in this invoice ?

Definition in file latex_invoices.py.

Function Documentation

invoice_to_lco()

def latex_invoices.invoice_to_lco

(

invoice

)

returns a string which forms a lco-file for use with LaTeX

Definition at line 91 of file latex_invoices.py.

def invoice_to_lco(invoice):
    """returns a string which forms a lco-file for use with LaTeX"""

    lco_out = u"\ProvidesFile{data.lco}[]\n"

    def write_variable(ukey, uvalue, replace_linebreak=True):

        outstr = u""
        if uvalue.endswith("\n"):
            uvalue = uvalue[0 : len(uvalue) - 1]

        if not ukey in [u"fromaddress", u"toaddress", u"date"]:
            outstr += u"\\newkomavar{"
            outstr += ukey
            outstr += u"}\n"

        outstr += u"\\setkomavar{"
        outstr += ukey
        outstr += u"}{"
        if replace_linebreak:
            outstr += uvalue.replace(u"\n", u"\\\\") + "}"
        return outstr

    # Write owners address
    add_str = u""
    owner = invoice.GetOwner()
    if owner.GetName() != "":
        add_str += owner.GetName() + "\n"

    addr = owner.GetAddr()
    if addr.GetName() != "":
        add_str += addr.GetName() + "\n"
    if addr.GetAddr1() != "":
        add_str += addr.GetAddr1() + "\n"
    if addr.GetAddr2() != "":
        add_str += addr.GetAddr2() + "\n"
    if addr.GetAddr3() != "":
        add_str += addr.GetAddr3() + "\n"
    if addr.GetAddr4() != "":
        add_str += addr.GetAddr4() + "\n"

    lco_out += write_variable("toaddress2", add_str)

    # Invoice number
    inr_str = invoice.GetID()
    lco_out += write_variable("rechnungsnummer", inr_str)

    # date
    date = invoice.GetDatePosted()
    udate = date.strftime("%d.%m.%Y")
    lco_out += write_variable("date", udate) + "\n"

    # date due
    date_due = invoice.GetDateDue()
    udate_due = date_due.strftime("%d.%m.%Y")
    lco_out += write_variable("date_due", udate_due) + "\n"

    # Write the entries
    ent_str = u""
    locale.setlocale(locale.LC_ALL, "")
    for n, ent in enumerate(invoice.GetEntries()):

        line_str = u""

        if type(ent) != Entry:
            ent = Entry(instance=ent)  # Add to method_returns_list

        descr = ent.GetDescription()
        price = ent.GetInvPrice().to_double()
        n = ent.GetQuantity()

        uprice = locale.currency(price).rstrip(" EUR")
        un = str(
            int(float(n.num()) / n.denom())
        )  # choose best way to format numbers according to locale

        line_str = u"\Artikel{"
        line_str += un
        line_str += u"}{"
        line_str += descr
        line_str += u"}{"
        line_str += uprice
        line_str += u"}"

        # print(line_str)
        ent_str += line_str

    lco_out += write_variable("entries", ent_str)

    return lco_out