diff --git a/report_py3o/readme/CONFIGURE.rst b/report_py3o/readme/CONFIGURE.rst new file mode 100644 index 00000000..676813b7 --- /dev/null +++ b/report_py3o/readme/CONFIGURE.rst @@ -0,0 +1,90 @@ +For example, to replace the native invoice report by a custom py3o report, add the following XML file in your custom module: + +.. code:: + + + + + + py3o + odt + my_custom_module_base + report/account_invoice.odt + + + + +where *my_custom_module_base* is the name of the custom Odoo module. In this example, the invoice ODT file is located in *my_custom_module_base/report/account_invoice.odt*. + +It's also possible to reference a template located in a trusted path of your +Odoo server. In this case you must let the *module* entry empty and specify +the path to the template as *py3o_template_fallback*. + +.. code:: + + + + + + py3o + odt + /odoo/templates/py3o/report/account_invoice.odt + + + + +Moreover, you must also modify the Odoo server configuration file to declare +the allowed root directory for your py3o templates. Only templates located +into this directory can be loaded by py3o report. + +.. code:: + + [options] + ... + + [report_py3o] + root_tmpl_path=/odoo/templates/py3o + +If you want an invoice in PDF format instead of ODT format, the XML file should look like: + +.. code:: + + + + + + py3o + pdf + my_custom_module_base + report/account_invoice.odt + + + + +If you want to add a new py3o PDF report (and not replace a native report), the XML file should look like this: + +.. code:: + + + + + + Partner Summary + res.partner + res.partner.summary + py3o + pdf + my_custom_module_base + report/partner_summary.odt + + report + + + + + +Configuration parameters +------------------------ + +py3o.conversion_command + The command to be used to run the conversion, ``libreoffice`` by default. If you change this, whatever you set here must accept the parameters ``--headless --convert-to $ext $file`` and put the resulting file into ``$file``'s directory with extension ``$ext``. The command will be started in ``$file``'s directory. diff --git a/report_py3o/readme/CONTRIBUTORS.rst b/report_py3o/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..ed9db733 --- /dev/null +++ b/report_py3o/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Florent Aide (`XCG Consulting `_) +* Laurent Mignon , +* Alexis de Lattre , +* Guewen Baconnier +* Omar Castiñeira +* Holger Brunn diff --git a/report_py3o/readme/DESCRIPTION.rst b/report_py3o/readme/DESCRIPTION.rst new file mode 100644 index 00000000..97c88395 --- /dev/null +++ b/report_py3o/readme/DESCRIPTION.rst @@ -0,0 +1,16 @@ +The py3o reporting engine is a reporting engine for Odoo based on `Libreoffice `_: + +* the report is created with Libreoffice (ODT or ODS), +* the report is stored on the server in OpenDocument format (.odt or .ods file) +* the report is sent to the user in OpenDocument format or in any output format supported by Libreoffice (PDF, HTML, DOC, DOCX, Docbook, XLS, etc.) + +The key advantages of a Libreoffice based reporting engine are: + +* no need to be a developer to create or modify a report: the report is created and modified with Libreoffice. So this reporting engine has a full WYSIWYG report development tool! +* For a PDF report in A4/Letter format, it's easier to develop it with a tool such as Libreoffice that is designed to create A4/Letter documents than to develop it in HTML/CSS, also some print peculiarities (backgrounds, margin boxes) are not very well supported by the HTML/CSS based solutions. +* If you want your users to be able to modify the document after its generation by Odoo, just configure the document with ODT output (or DOC or DOCX) and the user will be able to modify the document with Libreoffice (or Word) after its generation by Odoo. +* Easy development of spreadsheet reports in ODS format (XLS output possible). + +This module *report_py3o* is the base module for the Py3o reporting engine. If used alone, it will spawn a libreoffice process for each ODT to PDF (or ODT to DOCX, ..) document conversion. This is slow and can become a problem if you have a lot of reports to convert from ODT to another format. In this case, you should consider the additionnal module *report_py3o_fusion_server* which is designed to work with a libreoffice daemon. With *report_py3o_fusion_server*, the technical environnement is more complex to setup because you have to install additionnal software components and run 2 daemons, but you have much better performances and you can configure the libreoffice PDF export options in Odoo (allows to generate PDF forms, PDF/A documents, password-protected PDFs, watermarked PDFs, etc.). + +This reporting engine is an alternative to `Aeroo `_: these two reporting engines have similar features but their implementation is entirely different. You cannot use aeroo templates as drop in replacement though, you'll have to change a few details. diff --git a/report_py3o/readme/INSTALL.rst b/report_py3o/readme/INSTALL.rst new file mode 100644 index 00000000..24bebaf4 --- /dev/null +++ b/report_py3o/readme/INSTALL.rst @@ -0,0 +1,12 @@ +Install the required python libs: + +.. code:: + + pip install py3o.template + pip install py3o.formats + +To allow the conversion of ODT or ODS reports to other formats (PDF, DOC, DOCX, etc.), install libreoffice: + +.. code:: + + apt-get --no-install-recommends install libreoffice diff --git a/report_py3o/readme/ROADMAP.rst b/report_py3o/readme/ROADMAP.rst new file mode 100644 index 00000000..568db673 --- /dev/null +++ b/report_py3o/readme/ROADMAP.rst @@ -0,0 +1,3 @@ +* generate barcode ? +* add more detailed example in demo file to showcase features +* add migration guide aeroo -> py3o diff --git a/report_py3o/readme/USAGE.rst b/report_py3o/readme/USAGE.rst new file mode 100644 index 00000000..dc78f573 --- /dev/null +++ b/report_py3o/readme/USAGE.rst @@ -0,0 +1,29 @@ +The templating language is `extensively documented `_, the records are exposed in libreoffice as ``objects``, on which you can also call functions. + +Available functions and objects +------------------------------- + +user + Browse record of current user +lang + The user's company's language as string (ISO code) +b64decode + ``base64.b64decode`` +format_multiline_value(string) + Generate the ODF equivalent of ``
`` and `` `` for multiline fields (ODF is XML internally, so those would be skipped otherwise) +html_sanitize(string) + Sanitize HTML string +time + Python's ``time`` module +display_address(partner) + Return a formatted string of the partner's address +o_format_lang(value, lang_code=False, digits=None, grouping=True, monetary=False, dp=False, currency_obj=False, no_break_space=True) + Return a formatted numeric or monetary value according to the context language and timezone +o_format_date(value, lang_code=False, date_format=False) + Return a formatted date or time value according to the context language and timezone + + +Sample report templates +----------------------- + +Sample py3o report templates for the main Odoo native reports (invoice, sale order, purchase order, picking, etc.) are available on the Github project `odoo-py3o-report-templates `_. diff --git a/report_py3o_fusion_server/readme/CONFIGURE.rst b/report_py3o_fusion_server/readme/CONFIGURE.rst new file mode 100644 index 00000000..1d22145f --- /dev/null +++ b/report_py3o_fusion_server/readme/CONFIGURE.rst @@ -0,0 +1,4 @@ +To configure the PDF export options: + +1. Go to the menu *Settings > Technical > Reporting > Py3o > Py3o PDF Export Options* and create a PDF export options profile. +#. Set the PDF export options profile on the Py3o Server (menu *Settings > Technical > Reporting > Py3o > Py3o Servers*) or on a particular Py3o report with PDF output format (menu *Settings > Technical > Actions > Reports*). diff --git a/report_py3o_fusion_server/readme/CONTRIBUTORS.rst b/report_py3o_fusion_server/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..ed9db733 --- /dev/null +++ b/report_py3o_fusion_server/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Florent Aide (`XCG Consulting `_) +* Laurent Mignon , +* Alexis de Lattre , +* Guewen Baconnier +* Omar Castiñeira +* Holger Brunn diff --git a/report_py3o_fusion_server/readme/DESCRIPTION.rst b/report_py3o_fusion_server/readme/DESCRIPTION.rst new file mode 100644 index 00000000..010614c5 --- /dev/null +++ b/report_py3o_fusion_server/readme/DESCRIPTION.rst @@ -0,0 +1,9 @@ +This module was written to let a py3o fusion server handle format conversion instead of local libreoffice. If you install this module above the *report_py3o* module, you will have to deploy additionnal software components and run 3 daemons (libreoffice, py3o.fusion and py3o.renderserver). This additionnal complexiy comes with several advantages: + +* much better performances (Libreoffice runs permanently in the background, no need to spawn a new Libreoffice instance upon every document conversion). +* ability to configure PDF export options in Odoo. This brings many new possibilities such as the ability to generate: + + * PDF forms + * PDF/A documents (required by some electronic invoicing standards such as `Factur-X `_) + * watermarked PDF documents + * password-protected PDF documents diff --git a/report_py3o_fusion_server/readme/INSTALL.rst b/report_py3o_fusion_server/readme/INSTALL.rst new file mode 100644 index 00000000..3824112d --- /dev/null +++ b/report_py3o_fusion_server/readme/INSTALL.rst @@ -0,0 +1,77 @@ +Install several additional components and Python libs: + +* `Py3o Fusion server `_, +* `Py3o render server `_, +* a Java Runtime Environment (JRE), which can be OpenJDK, +* Libreoffice started in the background in headless mode, +* the Java driver for Libreoffice (Juno). + +It is also possible to use the Python driver for Libreoffice (PyUNO), but it is recommended to use the Java driver because it is more stable. + +The installation procedure below uses the Java driver. It has been successfully tested on Ubuntu 18.04 LTS ; if you use another OS, you may have to change a few details. + +Installation of Libreoffice, JRE and required Java libs on Debian/Ubuntu: + +.. code:: + + sudo apt-get install default-jre ure libgoogle-gson-java libreoffice-java-common libreoffice-writer + +You may have to install additionnal fonts. For example, to have the special unicode symbols for phone/fax/email in the PDF reports generated by Py3o, you should install the following package: + +.. code:: + + sudo apt-get install fonts-symbola + +Installation of py3o.fusion: + +.. code:: + + pip3 install py3o.fusion + pip3 install service-identity + +Installation of py3o.renderserver: + +.. code:: + + pip3 install py3o.renderserver + +At the end, with the dependencies, you should have the following py3o python libs: + +.. code:: + + % pip3 freeze | grep py3o + py3o.formats==0.3 + py3o.fusion==0.8.9 + py3o.renderclient==0.3 + py3o.renderers.juno==0.8.1 + py3o.renderserver==0.5.2 + py3o.template==0.10.0 + py3o.types==0.1.1 + +Start the Py3o Fusion server: + +.. code:: + + start-py3o-fusion --debug -s localhost -i localhost + +Start the Py3o render server: + +.. code:: + + start-py3o-renderserver --java=/usr/lib/jvm/default-java/lib/server/libjvm.so --ure=/usr/share --office=/usr/lib/libreoffice --driver=juno --sofficeport=8997 -i localhost + +On the output of the Py3o render server, the first line looks like: + +.. code:: + + DEBUG:root:Starting JVM: /usr/lib/jvm/default-java/lib/server/libjvm.so with options: -Djava.class.path=/usr/local/lib/python2.7/dist-packages/py3o/renderers/juno/py3oconverter.jar:/usr/share/java/juh.jar:/usr/share/java/jurt.jar:/usr/share/java/ridl.jar:/usr/share/java/unoloader.jar:/usr/share/java/java_uno.jar:/usr/lib/libreoffice/program/classes/unoil.jar -Xmx150M + +After **-Djava.class.path**, there is a list of Java libs with *.jar* extension ; check that each JAR file is really present on your filesystem. If one of the jar files is present in another directory, create a symlink that points to the real location of the file. If all the jar files are present on another directory, adapt the *--ure=* argument on the command line of Py3o render server. + +To check that the Py3o Fusion server is running fine, visit the URL http://:8765/form. On this web page, under the section *Target format*, make sure that you have a line *This server currently supports these formats: ods, odt, docx, doc, html, docbook, pdf, xls.*. + +If you want to produce valid PDF/A documents with this module, activating the corresponding option in the PDF Export Options may not be enough, you also have to make sure that all the fonts used in the document template are installed on the Odoo server, so that they can be embedded in the PDF/A document. For example, if your document template uses the Arial font, you should install that font on your Odoo server: + +.. code:: + + sudo apt-get install msttcorefonts diff --git a/report_py3o_fusion_server/readme/ROADMAP.rst b/report_py3o_fusion_server/readme/ROADMAP.rst new file mode 100644 index 00000000..78335732 --- /dev/null +++ b/report_py3o_fusion_server/readme/ROADMAP.rst @@ -0,0 +1 @@ +* Add support for PDF signatures (possible, but no easy because the signature certificate is a very particular PDF export option)