README.rst

InvoiceGenerator

This is library to generate a simple PDF invoice. It's based on ReportLab.

Installation

Run this command as root:

pip install InvoiceGenerator

If you want upgrade to new version, add --upgrade flag.:

pip install InvoiceGenerator --upgrade

You can use setup.py from GitHub repository too.:

python setup.py install

Example

Usage:

    from tempfile import NamedTemporaryFile

    from InvoiceGenerator.api import Invoice, Item, Client, Provider, Creator
    from InvoiceGenerator.pdf import SimpleInvoice

# choose en as language
os.environ["INVOICE_LANG"] = "en"

    client = Client('Client company')
    provider = Provider('My company', bank_account='2600420569/2010')
    creator = Creator('John Doe')

    invoice = Invoice(client, provider, creator)
    invoice.currency_locale = 'en_US.UTF-8'
    invoice.add_item(Item(32, 600, description="Item 1"))
    invoice.add_item(Item(60, 50, description="Item 2", tax=10))
    invoice.add_item(Item(50, 60, description="Item 3", tax=5))
    invoice.add_item(Item(5, 600, description="Item 4", tax=50))

    tmp_file = NamedTemporaryFile(delete=False)
    pdf = SimpleInvoice(invoice)
    pdf.gen(tmp_file.name, generate_qr_code=True)

Hacking

Fork the repository on github and write code. Make sure to add tests covering your code under /tests/. You can run tests using:

python setup.py test

Then propose your patch via a pull request.

Documentation is generated from doc/source/ using Sphinx:

python setup.py build_sphinx

Then head to doc/build/html/index.html.