https://github.com/by-cx/InvoiceGenerator
Library to generate PDF invoices.
https://github.com/by-cx/InvoiceGenerator
Last synced: 25 days ago
JSON representation
Library to generate PDF invoices.
- Host: GitHub
- URL: https://github.com/by-cx/InvoiceGenerator
- Owner: by-cx
- Created: 2011-08-08T15:07:10.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2024-07-14T07:45:35.000Z (9 months ago)
- Last Synced: 2025-03-12T20:41:31.015Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 1.4 MB
- Stars: 171
- Watchers: 8
- Forks: 118
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
Awesome Lists containing this project
- awesome-billing - InvoiceGenerator - Library to generate a simple invoices. (Invoice / Generators)
README
================
InvoiceGenerator
================
.. image:: https://travis-ci.org/by-cx/InvoiceGenerator.svg?branch=master
:target: https://travis-ci.org/by-cx/InvoiceGenerator
.. image:: https://img.shields.io/pypi/v/InvoiceGenerator.svg
:target: https://pypi.python.org/pypi/InvoiceGenerator/
:alt: Latest Version
This is library to generate a simple invoices.
Currently supported formats are PDF and XML for Pohoda accounting system.
PDF invoice is based on ReportLab.
.. image:: https://raw.githubusercontent.com/mezka/InvoiceGenerator/master/example_with_vat.png
:alt: Example image of invoice
:width: 25%
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
Documentation
-------------
Complete documentation is available on
`Read The Docs `_.
Example
=======
Basic API
---------
Define invoice data first::
import os
from tempfile import NamedTemporaryFile
from InvoiceGenerator.api import Invoice, Item, Client, Provider, Creator
# choose english as language
os.environ["INVOICE_LANG"] = "en"
client = Client('Client company')
provider = Provider('My company', bank_account='2600420569', bank_code='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=21))
invoice.add_item(Item(50, 60, description="Item 3", tax=0))
invoice.add_item(Item(5, 600, description="Item 4", tax=15))
Note: Due to Python's representational error, write numbers as integer ``tax=10``,
Decimal ``tax=Decimal('10.1')`` or string ``tax='1.2'`` to avoid getting results with
lot of decimal places.
PDF
---
Generate PDF invoice file::
from InvoiceGenerator.pdf import SimpleInvoice
pdf = SimpleInvoice(invoice)
pdf.gen("invoice.pdf", generate_qr_code=True)
Pohoda XML
----------
Generate XML invoice file::
from InvoiceGenerator.pohoda import SimpleInvoice
pdf = SimpleInvoice(invoice)
pdf.gen("invoice.xml")
Note: Pohoda uses three tax rates: none: 0%, low: 15%, high: 21%.
If any item doesn't meet those percentage, the rateVat parameter will
not be set for those items resulting in 0% tax rate.
Only SimpleInvoice is currently supported for Pohoda XML format.
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`.