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
	latex_invoices.invoice_to_lco (invoice)
	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()

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
 
 

main()

latex_invoices.main

(

argv = None

)

Definition at line 183 of file latex_invoices.py.

def main(argv=None):
    if argv is None:
        argv = sys.argv
    try:
        prog_name = argv[0]
        with_ipshell = False
        ignore_lock = False
        no_latex_output = True
        list_invoices = False
        output_file_name = "data.lco"
        invoice_number = None
 
        try:
            opts, args = getopt.getopt(argv[1:], "fhiln:po:", ["help"])
        except getopt.error as msg:
            raise Usage(msg)
 
        for opt in opts:
            if opt[0] in ["-f"]:
                print("ignoring lock")
                ignore_lock = True
            if opt[0] in ["-h", "--help"]:
                raise Usage("Help:")
            if opt[0] in ["-i"]:
                print("Using ipshell")
                with_ipshell = True
            if opt[0] in ["-l"]:
                print("listing all invoices")
                list_invoices = True
            if opt[0] in ["-n"]:
                invoice_number = int(opt[1])
                print("using invoice number", invoice_number)
                no_latex_output = False
            if opt[0] in ["-o"]:
                output_file_name = opt[1]
                print("using output file", output_file_name)
        if len(args) > 1:
            print("opts:", opts, "args:", args)
            raise Usage("Only one input can be accepted !")
        if len(args) == 0:
            raise Usage("No input given !")
        input_url = args[0]
    except Usage as err:
        if err.msg == "Help:":
            retcode = 0
        else:
            print("Error:", err.msg, file=sys.stderr)
            print("for help use --help", file=sys.stderr)
            retcode = 2
 
        print("Generate a LaTeX invoice or print out all invoices.")
        print()
        print("Usage:")
        print()
        print("Invoke with", prog_name, "input.")
        print("where input is")
        print("   filename")
        print("or file://filename")
        print("or mysql://user:password@host/databasename")
        print()
        print("-f             force open = ignore lock")
        print("-h or --help   for this help")
        print("-i             for ipython shell")
        print("-l             list all invoices")
        print("-n number      use invoice number (no. from previous run with -l)")
        print("-o name        use name as outputfile. default: data.lco")
 
        return retcode
 
    # Try to open the given input
    try:
        session = gnucash.Session(
            input_url,
            SessionOpenMode.SESSION_READ_ONLY
            if ignore_lock
            else SessionOpenMode.SESSION_NORMAL_OPEN,
        )
    except Exception as exception:
        print("Problem opening input.")
        print(exception)
        return 2
 
    book = session.book
    root_account = book.get_root_account()
    comm_table = book.get_table()
    EUR = comm_table.lookup("CURRENCY", "EUR")
 
    invoice_list = get_all_invoices(book)
 
    if list_invoices:
        for number, invoice in enumerate(invoice_list):
            print(str(number) + ")")
            print(invoice)
 
    if not (no_latex_output):
 
        if invoice_number == None:
            print("Using the first invoice:")
            invoice_number = 0
 
        invoice = invoice_list[invoice_number]
        print("Using the following invoice:")
        print(invoice)
 
        lco_str = invoice_to_lco(invoice)
 
        # Opening output file
        f = open(output_file_name, "w")
        f.write(lco_str)
        f.close()
 
    if with_ipshell:
        app = TerminalIPythonApp.instance()
        app.initialize(argv=[])  # argv=[] instructs IPython to ignore sys.argv
        app.start()
 
    # session.save()
    session.end()