The py3o reporting engine is a reporting engine for Odoo based on Libreoffice:
+The key advantages of a Libreoffice based reporting engine are:
+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.
+Table of contents
+Install the required python libs:
++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:
++apt-get --no-install-recommends install libreoffice ++
For example, to replace the native invoice report by a custom py3o report, add the following XML file in your custom module:
++<?xml version="1.0" encoding="utf-8"?> +<odoo> + +<record id="account.account_invoices" model="ir.actions.report"> + <field name="report_type">py3o</field> + <field name="py3o_filetype">odt</field> + <field name="module">my_custom_module_base</field> + <field name="py3o_template_fallback">report/account_invoice.odt</field> +</record> + +</odoo> ++
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.
++<?xml version="1.0" encoding="utf-8"?> +<odoo> + +<record id="account.account_invoices" model="ir.actions.report"> + <field name="report_type">py3o</field> + <field name="py3o_filetype">odt</field> + <field name="py3o_template_fallback">/odoo/templates/py3o/report/account_invoice.odt</field> +</record> + +</odoo> ++
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.
++[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:
++<?xml version="1.0" encoding="utf-8"?> +<odoo> + +<record id="account.account_invoices" model="ir.actions.report"> + <field name="report_type">py3o</field> + <field name="py3o_filetype">pdf</field> + <field name="module">my_custom_module_base</field> + <field name="py3o_template_fallback">report/account_invoice.odt</field> +</record> + +</odoo> ++
If you want to add a new py3o PDF report (and not replace a native report), the XML file should look like this:
++<?xml version="1.0" encoding="utf-8"?> +<odoo> + +<record id="partner_summary_report" model="ir.actions.report"> + <field name="name">Partner Summary</field> + <field name="model">res.partner</field> + <field name="report_name">res.partner.summary</field> + <field name="report_type">py3o</field> + <field name="py3o_filetype">pdf</field> + <field name="module">my_custom_module_base</field> + <field name="py3o_template_fallback">report/partner_summary.odt</field> + <!-- Add entry in "Print" drop-down list --> + <field name="binding_type">report</field> + <field name="binding_model_id" ref="base.model_res_partner"/> +</record> + +</odoo> ++
The templating language is extensively documented, the records are exposed in libreoffice as objects, on which you can also call functions.
+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.
+Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.
+Do not contact contributors directly about support or help with technical issues.
+This module is maintained by the OCA.
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.
+This module is part of the OCA/reporting-engine project on GitHub.
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
+