diff --git a/report_xml/README.rst b/report_xml/README.rst index c15199c73..59613486f 100644 --- a/report_xml/README.rst +++ b/report_xml/README.rst @@ -17,20 +17,20 @@ XML Reports :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github - :target: https://github.com/OCA/reporting-engine/tree/16.0/report_xml + :target: https://github.com/OCA/reporting-engine/tree/17.0/report_xml :alt: OCA/reporting-engine .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_xml + :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_xml :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png - :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| -This module was written to extend the functionality of the reporting engine to -support XML reports and allow modules to generate them by code or by QWeb -templates. +This module was written to extend the functionality of the reporting +engine to support XML reports and allow modules to generate them by code +or by QWeb templates. **Table of contents** @@ -42,59 +42,62 @@ Installation To install this module, you need to: -* Install lxml_ in Odoo's ``$PYTHONPATH``. -* Install the repository `reporting-engine`_. +- Install `lxml `__ in Odoo's ``$PYTHONPATH``. +- Install the repository + `reporting-engine `__. -But this module does nothing for the end user by itself, so if you have it -installed it's probably because there is another module that depends on it. - -.. _reporting-engine: https://github.com/OCA/reporting-engine -.. _lxml: http://lxml.de/ +But this module does nothing for the end user by itself, so if you have +it installed it's probably because there is another module that depends +on it. Usage ===== -This module is intended as a base engine for other modules to use it, so no direct result if you are a user. +This module is intended as a base engine for other modules to use it, so +no direct result if you are a user. If you are a developer -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- -To learn from an example, just check the `demo report`_ on GitHub for -the model ``res.company`` or check it in interface from companies views. +To learn from an example, just check the `demo +report `__ +on GitHub for the model ``res.company`` or check it in interface from +companies views. To develop with this module, you need to: -* Create a module. -* Make it depend on this one. -* Follow `instructions to create reports`_ having in mind that the - ``report_type`` field in your ``ir.actions.report`` record must be - ``qweb-xml``. +- Create a module. +- Make it depend on this one. +- Follow `instructions to create + reports `__ + having in mind that the ``report_type`` field in your + ``ir.actions.report`` record must be ``qweb-xml``. -In case you want to create a `custom report`_, the instructions remain the same -as for HTML reports, and the method that you must override is also called -``_get_report_values``, even when this time you are creating a XML report. +In case you want to create a `custom +report `__, +the instructions remain the same as for HTML reports, and the method +that you must override is also called ``_get_report_values``, even when +this time you are creating a XML report. -You can make your custom report inherit ``report.report_xml.abstract``, name -it in such way ``report.``. Also you can add a XSD file for -report validation into ``xsd_schema`` field of your report (check -`report definition`_) and have XSD automatic checking for -free. +You can make your custom report inherit ``report.report_xml.abstract``, +name it in such way ``report.``. Also you can add a +XSD file for report validation into ``xsd_schema`` field of your report +(check `report +definition `__) +and have XSD automatic checking for free. -You can customize rendering process and validation way via changing logic of -``generate_report`` and ``validate_report`` methods in your report class. +You can customize rendering process and validation way via changing +logic of ``generate_report`` and ``validate_report`` methods in your +report class. -You can visit ``http:///report/xml//`` -to see your XML report online as a web page. +You can visit +``http:///report/xml//`` to see +your XML report online as a web page. For further information, please visit: -* https://www.odoo.com/forum/help-1 -* https://github.com/OCA/reporting-engine - -.. _custom report: https://www.odoo.com/documentation/13.0/reference/reports.html#custom-reports -.. _instructions to create reports: https://www.odoo.com/documentation/13.0/reference/reports.html -.. _demo report: https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/demo_report.xml -.. _report definition: https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/report.xml +- https://www.odoo.com/forum/help-1 +- https://github.com/OCA/reporting-engine Bug Tracker =========== @@ -102,7 +105,7 @@ Bug Tracker 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 to smash it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -110,28 +113,33 @@ Credits ======= Authors -~~~~~~~ +------- * Tecnativa * Avoin.Systems Contributors -~~~~~~~~~~~~ +------------ -* Enric Tobella -* `Tecnativa `_: - * Jairo Llopis -* `Avoin.Systems `_: - * Tatiana Deribina -* Iván Antón +- Enric Tobella + +- `Tecnativa `__: + + - Jairo Llopis + +- `Avoin.Systems `__: + + - Tatiana Deribina + +- Iván Antón Other credits -~~~~~~~~~~~~~ +------------- -* Icon taken from http://commons.wikimedia.org/wiki/File:Text-xml.svg +- Icon taken from http://commons.wikimedia.org/wiki/File:Text-xml.svg Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -143,6 +151,6 @@ 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. +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. diff --git a/report_xml/hooks.py b/report_xml/hooks.py index c80a3c7a3..f9c24d6b7 100644 --- a/report_xml/hooks.py +++ b/report_xml/hooks.py @@ -32,7 +32,7 @@ def post_init_hook(cr, registry): xsd_file_relative_path = "demo/demo_report.xsd" xsd_file_full_path = os.path.join(dir_path, xsd_file_relative_path) - with open(xsd_file_full_path, "r") as xsd: + with open(xsd_file_full_path) as xsd: # `xsd_schema` is binary fields with an attribute # `attachment=True` so XSD Schema will be added as attachment attach_vals = { diff --git a/report_xml/pyproject.toml b/report_xml/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/report_xml/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/report_xml/readme/CONTRIBUTORS.md b/report_xml/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..a11738d9c --- /dev/null +++ b/report_xml/readme/CONTRIBUTORS.md @@ -0,0 +1,9 @@ +- Enric Tobella \<\> + +- [Tecnativa](https://www.tecnativa.com): + - Jairo Llopis + +- [Avoin.Systems](https://avoin.systems/): + - Tatiana Deribina + +- Iván Antón \<\> diff --git a/report_xml/readme/CONTRIBUTORS.rst b/report_xml/readme/CONTRIBUTORS.rst deleted file mode 100644 index 6a3fdad2d..000000000 --- a/report_xml/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,6 +0,0 @@ -* Enric Tobella -* `Tecnativa `_: - * Jairo Llopis -* `Avoin.Systems `_: - * Tatiana Deribina -* Iván Antón diff --git a/report_xml/readme/CREDITS.md b/report_xml/readme/CREDITS.md new file mode 100644 index 000000000..f94e6ea0e --- /dev/null +++ b/report_xml/readme/CREDITS.md @@ -0,0 +1,2 @@ +- Icon taken from + diff --git a/report_xml/readme/CREDITS.rst b/report_xml/readme/CREDITS.rst deleted file mode 100644 index 57a4af34f..000000000 --- a/report_xml/readme/CREDITS.rst +++ /dev/null @@ -1 +0,0 @@ -* Icon taken from http://commons.wikimedia.org/wiki/File:Text-xml.svg diff --git a/report_xml/readme/DESCRIPTION.md b/report_xml/readme/DESCRIPTION.md new file mode 100644 index 000000000..94ee896d4 --- /dev/null +++ b/report_xml/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module was written to extend the functionality of the reporting +engine to support XML reports and allow modules to generate them by code +or by QWeb templates. diff --git a/report_xml/readme/DESCRIPTION.rst b/report_xml/readme/DESCRIPTION.rst deleted file mode 100644 index 9b00f936c..000000000 --- a/report_xml/readme/DESCRIPTION.rst +++ /dev/null @@ -1,3 +0,0 @@ -This module was written to extend the functionality of the reporting engine to -support XML reports and allow modules to generate them by code or by QWeb -templates. diff --git a/report_xml/readme/INSTALL.md b/report_xml/readme/INSTALL.md new file mode 100644 index 000000000..18ebbc068 --- /dev/null +++ b/report_xml/readme/INSTALL.md @@ -0,0 +1,9 @@ +To install this module, you need to: + +- Install [lxml](http://lxml.de/) in Odoo's `$PYTHONPATH`. +- Install the repository + [reporting-engine](https://github.com/OCA/reporting-engine). + +But this module does nothing for the end user by itself, so if you have +it installed it's probably because there is another module that depends +on it. diff --git a/report_xml/readme/INSTALL.rst b/report_xml/readme/INSTALL.rst deleted file mode 100644 index e69d093e3..000000000 --- a/report_xml/readme/INSTALL.rst +++ /dev/null @@ -1,10 +0,0 @@ -To install this module, you need to: - -* Install lxml_ in Odoo's ``$PYTHONPATH``. -* Install the repository `reporting-engine`_. - -But this module does nothing for the end user by itself, so if you have it -installed it's probably because there is another module that depends on it. - -.. _reporting-engine: https://github.com/OCA/reporting-engine -.. _lxml: http://lxml.de/ diff --git a/report_xml/readme/USAGE.md b/report_xml/readme/USAGE.md new file mode 100644 index 000000000..5702160ad --- /dev/null +++ b/report_xml/readme/USAGE.md @@ -0,0 +1,44 @@ +This module is intended as a base engine for other modules to use it, so +no direct result if you are a user. + +## If you are a developer + +To learn from an example, just check the [demo +report](https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/demo_report.xml) +on GitHub for the model `res.company` or check it in interface from +companies views. + +To develop with this module, you need to: + +- Create a module. +- Make it depend on this one. +- Follow [instructions to create + reports](https://www.odoo.com/documentation/13.0/reference/reports.html) + having in mind that the `report_type` field in your + `ir.actions.report` record must be `qweb-xml`. + +In case you want to create a [custom +report](https://www.odoo.com/documentation/13.0/reference/reports.html#custom-reports), +the instructions remain the same as for HTML reports, and the method +that you must override is also called `_get_report_values`, even when +this time you are creating a XML report. + +You can make your custom report inherit `report.report_xml.abstract`, +name it in such way `report.`. Also you can add a +XSD file for report validation into `xsd_schema` field of your report +(check [report +definition](https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/report.xml)) +and have XSD automatic checking for free. + +You can customize rendering process and validation way via changing +logic of `generate_report` and `validate_report` methods in your report +class. + +You can visit +`http:///report/xml//` to see +your XML report online as a web page. + +For further information, please visit: + +- +- diff --git a/report_xml/readme/USAGE.rst b/report_xml/readme/USAGE.rst deleted file mode 100644 index 3574a6bb3..000000000 --- a/report_xml/readme/USAGE.rst +++ /dev/null @@ -1,41 +0,0 @@ -This module is intended as a base engine for other modules to use it, so no direct result if you are a user. - -If you are a developer -~~~~~~~~~~~~~~~~~~~~~~ - -To learn from an example, just check the `demo report`_ on GitHub for -the model ``res.company`` or check it in interface from companies views. - -To develop with this module, you need to: - -* Create a module. -* Make it depend on this one. -* Follow `instructions to create reports`_ having in mind that the - ``report_type`` field in your ``ir.actions.report`` record must be - ``qweb-xml``. - -In case you want to create a `custom report`_, the instructions remain the same -as for HTML reports, and the method that you must override is also called -``_get_report_values``, even when this time you are creating a XML report. - -You can make your custom report inherit ``report.report_xml.abstract``, name -it in such way ``report.``. Also you can add a XSD file for -report validation into ``xsd_schema`` field of your report (check -`report definition`_) and have XSD automatic checking for -free. - -You can customize rendering process and validation way via changing logic of -``generate_report`` and ``validate_report`` methods in your report class. - -You can visit ``http:///report/xml//`` -to see your XML report online as a web page. - -For further information, please visit: - -* https://www.odoo.com/forum/help-1 -* https://github.com/OCA/reporting-engine - -.. _custom report: https://www.odoo.com/documentation/13.0/reference/reports.html#custom-reports -.. _instructions to create reports: https://www.odoo.com/documentation/13.0/reference/reports.html -.. _demo report: https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/demo_report.xml -.. _report definition: https://github.com/OCA/reporting-engine/blob/13.0/report_xml/demo/report.xml diff --git a/report_xml/static/description/index.html b/report_xml/static/description/index.html index ddd799440..7fc72d3d7 100644 --- a/report_xml/static/description/index.html +++ b/report_xml/static/description/index.html @@ -369,10 +369,10 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:ee669446f046a3e31fa4d2fb92a1fc85e3d2c57d618bf432aa8355f7c205d7c8 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Production/Stable License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

-

This module was written to extend the functionality of the reporting engine to -support XML reports and allow modules to generate them by code or by QWeb -templates.

+

Production/Stable License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

+

This module was written to extend the functionality of the reporting +engine to support XML reports and allow modules to generate them by code +or by QWeb templates.

Table of contents

    @@ -396,38 +396,49 @@ templates.

    To install this module, you need to:

    -

    But this module does nothing for the end user by itself, so if you have it -installed it’s probably because there is another module that depends on it.

    +

    But this module does nothing for the end user by itself, so if you have +it installed it’s probably because there is another module that depends +on it.

Usage

-

This module is intended as a base engine for other modules to use it, so no direct result if you are a user.

+

This module is intended as a base engine for other modules to use it, so +no direct result if you are a user.

If you are a developer

-

To learn from an example, just check the demo report on GitHub for -the model res.company or check it in interface from companies views.

+

To learn from an example, just check the demo +report +on GitHub for the model res.company or check it in interface from +companies views.

To develop with this module, you need to:

  • Create a module.
  • Make it depend on this one.
    • -
  • Follow instructions to create reports having in mind that the -report_type field in your ir.actions.report record must be -qweb-xml.
    • +
  • Follow instructions to create +reports +having in mind that the report_type field in your +ir.actions.report record must be qweb-xml.
-

In case you want to create a custom report, the instructions remain the same -as for HTML reports, and the method that you must override is also called -_get_report_values, even when this time you are creating a XML report.

-

You can make your custom report inherit report.report_xml.abstract, name -it in such way report.<module.report_name>. Also you can add a XSD file for -report validation into xsd_schema field of your report (check -report definition) and have XSD automatic checking for -free.

-

You can customize rendering process and validation way via changing logic of -generate_report and validate_report methods in your report class.

-

You can visit http://<server-address>/report/xml/<module.report_name>/<ids> -to see your XML report online as a web page.

+

In case you want to create a custom +report, +the instructions remain the same as for HTML reports, and the method +that you must override is also called _get_report_values, even when +this time you are creating a XML report.

+

You can make your custom report inherit report.report_xml.abstract, +name it in such way report.<module.report_name>. Also you can add a +XSD file for report validation into xsd_schema field of your report +(check report +definition) +and have XSD automatic checking for free.

+

You can customize rendering process and validation way via changing +logic of generate_report and validate_report methods in your +report class.

+

You can visit +http://<server-address>/report/xml/<module.report_name>/<ids> to see +your XML report online as a web page.

For further information, please visit:

  • https://www.odoo.com/forum/help-1
    • @@ -440,7 +451,7 @@ to see your XML report online as a web page.

    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 to smash it by providing a detailed and welcomed -feedback.

    +feedback.

    Do not contact contributors directly about support or help with technical issues.

@@ -456,21 +467,13 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

Contributors

@@ -488,7 +491,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

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.

+

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.

diff --git a/requirements.txt b/requirements.txt index c208f5bc3..4cdf72bb1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ # generated from manifests external_dependencies +lxml xlrd xlsxwriter