Debian packaging for factur-x
Go to file
Alexis de Lattre abadc914fa Initial check-in 2017-09-10 01:56:48 +02:00
bin Initial check-in 2017-09-10 01:56:48 +02:00
facturx Initial check-in 2017-09-10 01:56:48 +02:00
.gitignore Initial commit 2017-09-10 01:15:26 +02:00
LICENSE Initial check-in 2017-09-10 01:56:48 +02:00
MANIFEST.in Initial check-in 2017-09-10 01:56:48 +02:00
README.rst Initial check-in 2017-09-10 01:56:48 +02:00
requirement.txt Initial check-in 2017-09-10 01:56:48 +02:00
setup.py Initial check-in 2017-09-10 01:56:48 +02:00

README.rst

Factur-X Python library
=======================

Factur-X is the e-invoicing standard for France and Germany. The Factur-X specifications are available on the `FNFE-MPE website <http://fnfe-mpe.org/factur-x/>`_.

The main feature of this Python library is to generate Factur-X invoices from a regular PDF invoice and a Factur-X compliant XML file.

This lib provides additionnal features such as:

* extract the Factur-X XML file from a Factur-X PDF invoice,
* check a Factur-X XML file against the official XML Schema Definition.

Some of the features provided by this lib also work for the ZUGFeRD e-invoicing standard (the ancestor of the Factur-X standard).

Installation
============

```
sudo pip install --upgrade factur-x
```

Usage
=====

```
from facturx import generate_facturx

facturx_pdf_invoice = generate_facturx(regular_pdf_invoice, facturx_xml_file)
```

To have more examples, look at the source code of the command line tools located in the *bin* subdirectory.

Command line tools
==================

Several command line tools are provided with this lib:

* facturx-pdfgen: generate a Factur-X PDF invoice from a regular PDF invoice and an XML file
* facturx-pdfextractxml: extract the Factur-X XML file from a Factur-X PDF invoice
* facturx-xmlcheck: check a Factur-X XML file against the official Factur-X XML Schema Definition

All these commande line tools have a **-h** option that explains how to use them and shows all the available options.

Contributors
============

* Alexis de Lattre <alexis.delattre@akretion.com>