OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

94 lines
3.3 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ===========
  5. Report Py3o
  6. ===========
  7. The py3o reporting engine is a reporting engine for Odoo based on `Libreoffice <http://www.libreoffice.org/>`_:
  8. * the report is created with Libreoffice (ODT or ODS),
  9. * the report is stored on the server in OpenDocument format (.odt or .ods file)
  10. * 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.)
  11. The key advantages of a Libreoffice-based reporting engine are:
  12. * no need to be a developper to create or modify a report: the report is created and modified with Libreoffice. So this reporting engine has a fully WYSIWYG report developpment tool!
  13. * 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.
  14. * 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.
  15. * Easy development of spreadsheet reports in ODS format (XLS output possible).
  16. This reporting engine is an alternative to `Aeroo <https://github.com/aeroo/aeroo_reports>`_: these 2 reporting engines have similar features but their codes are completely different.
  17. Installation
  18. ============
  19. You must install 2 additionnal python libs:
  20. .. code::
  21. pip install py3o.template
  22. pip install py3o.formats
  23. If you want to convert the ODT or ODS report in another format, you need several additionnal components and Python libs:
  24. * `Py3o Fusion server <https://bitbucket.org/faide/py3o.fusion>`_
  25. * `Py3o render server <https://bitbucket.org/faide/py3o.renderserver>`_
  26. * Libreoffice started in the background in headless mode.
  27. TODO : continue
  28. Configuration
  29. =============
  30. If you want to convert the report in another format, go to the menu *Configuration > Technical > Reports > Py3o > Py3o Servers* and create a new Py3o server with its URL (for example: http://localhost:8765/form).
  31. TODO: continue
  32. Usage
  33. =====
  34. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  35. :alt: Try me on Runbot
  36. :target: https://runbot.odoo-community.org/runbot/143/9.0
  37. Known issues / Roadmap
  38. ======================
  39. * generate barcode ?
  40. Bug Tracker
  41. ===========
  42. Bugs are tracked on `GitHub Issues
  43. <https://github.com/OCA/reporting-engine/issues>`_. In case of trouble, please
  44. check there if your issue has already been reported. If you spotted it first,
  45. help us smashing it by providing a detailed and welcomed feedback.
  46. Credits
  47. =======
  48. Contributors
  49. ------------
  50. * Florent Aide (`XCG Consulting <http://odoo.consulting/>`_)
  51. * Laurent Mignon (Acsone)
  52. Maintainer
  53. ----------
  54. .. image:: https://odoo-community.org/logo.png
  55. :alt: Odoo Community Association
  56. :target: https://odoo-community.org
  57. This module is maintained by the OCA.
  58. OCA, or the Odoo Community Association, is a nonprofit organization whose
  59. mission is to support the collaborative development of Odoo features and
  60. promote its widespread use.
  61. To contribute to this module, please visit https://odoo-community.org.