entrouvert
/
debian-factur-x
16
0
Fork 0
Code Issues Pull Requests 1 Releases Activity

Fix and improve README

This commit is contained in:
Alexis de Lattre 2017-09-11 00:38:13 +02:00
parent abadc914fa
commit 0c10ba7da5
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.rst
View File

@ -15,18 +15,19 @@ Some of the features provided by this lib also work for the ZUGFeRD e-invoicing
Installation
============
```
sudo pip install --upgrade factur-x
```
.. code::
sudo pip install --upgrade factur-x
Usage
=====
```
from facturx import generate_facturx
.. code::
from facturx import generate_facturx
facturx_pdf_invoice = generate_facturx(regular_pdf_invoice, facturx_xml_file)
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.
@ -35,12 +36,17 @@ 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
* **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.
Licence
=======
This library is published under the BSD licence (same licence as `PyPDF2 <http://mstamy2.github.io/PyPDF2/>`_ on which this lib depends).
Contributors
============