From cade6cd68821a2403199a67a33b432d55a6ed751 Mon Sep 17 00:00:00 2001 From: Sander Lienaerts Date: Fri, 12 Jan 2024 15:43:17 +0100 Subject: [PATCH] [IMP] sql_export: black, isort, prettier --- sql_export/README.rst | 72 ++++++++++++------------ sql_export/pyproject.toml | 3 + sql_export/readme/CONTRIBUTORS.md | 6 ++ sql_export/readme/CONTRIBUTORS.rst | 9 --- sql_export/readme/DESCRIPTION.md | 4 ++ sql_export/readme/DESCRIPTION.rst | 4 -- sql_export/readme/ROADMAP.md | 16 ++++++ sql_export/readme/ROADMAP.rst | 16 ------ sql_export/readme/USAGE.md | 8 +++ sql_export/readme/USAGE.rst | 9 --- sql_export/static/description/index.html | 49 ++++++++-------- 11 files changed, 99 insertions(+), 97 deletions(-) create mode 100644 sql_export/pyproject.toml create mode 100644 sql_export/readme/CONTRIBUTORS.md delete mode 100644 sql_export/readme/CONTRIBUTORS.rst create mode 100644 sql_export/readme/DESCRIPTION.md delete mode 100644 sql_export/readme/DESCRIPTION.rst create mode 100644 sql_export/readme/ROADMAP.md delete mode 100644 sql_export/readme/ROADMAP.rst create mode 100644 sql_export/readme/USAGE.md delete mode 100644 sql_export/readme/USAGE.rst diff --git a/sql_export/README.rst b/sql_export/README.rst index 482d7a94a..30cf430b5 100644 --- a/sql_export/README.rst +++ b/sql_export/README.rst @@ -17,21 +17,21 @@ SQL Export :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/sql_export + :target: https://github.com/OCA/reporting-engine/tree/17.0/sql_export :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-sql_export + :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-sql_export :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| -Allow to export data in csv files FROM sql requests. -There are some restrictions in the sql query, you can only read datas. -No update, deletion or creation are possible. -A new sub menu named Sql Export is available in the Dashboard main menu. +Allow to export data in csv files FROM sql requests. There are some +restrictions in the sql query, you can only read datas. No update, +deletion or creation are possible. A new sub menu named Sql Export is +available in the Dashboard main menu. **Table of contents** @@ -41,35 +41,35 @@ A new sub menu named Sql Export is available in the Dashboard main menu. Usage ===== - Dashboards > Sql Export - **Specific use with parameters** -- `%(company_id)s` allows to set in the query the company id of the user -- `%(user_id)s` allows to set in the query the user id -- for any created property, you can use it with `%(Property String)s` syntax +- %(company_id)s allows to set in the query the company id of the user +- %(user_id)s allows to set in the query the user id +- for any created property, you can use it with %(Property String)s + syntax Known issues / Roadmap ====================== -* Some words are prohibited and can't be used is the query in anyways, even in - a select query: - - delete - - drop - - insert - - alter - - truncate - - execute - - create - - update +- Some words are prohibited and can't be used is the query in anyways, + even in a select query: + + - delete + - drop + - insert + - alter + - truncate + - execute + - create + - update See sql_request_abstract module to fix this issue. -* checking SQL request by execution and rollback is disabled in this module - since variables features has been introduced. This can be fixed by - overloading _prepare_request_check_execution() function. +- checking SQL request by execution and rollback is disabled in this + module since variables features has been introduced. This can be + fixed by overloading \_prepare_request_check_execution() function. Bug Tracker =========== @@ -77,7 +77,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. @@ -85,26 +85,26 @@ Credits ======= Authors -~~~~~~~ +------- * Akretion * GRAP Contributors -~~~~~~~~~~~~ +------------ -* `Akretion `_: +- `Akretion `__: - * Florian da Costa - * Mourad EL HADJ MIMOUNE - * Benoît GUILLOT + - Florian da Costa + - Mourad EL HADJ MIMOUNE + - Benoît GUILLOT -* `Eficent `_: +- `Eficent `__: - * Aaron Henriquez + - Aaron Henriquez Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -124,6 +124,6 @@ Current `maintainer `__: |maintainer-legalsylvain| -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/sql_export/pyproject.toml b/sql_export/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/sql_export/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/sql_export/readme/CONTRIBUTORS.md b/sql_export/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..6139017fd --- /dev/null +++ b/sql_export/readme/CONTRIBUTORS.md @@ -0,0 +1,6 @@ +- [Akretion](https://www.akretion.com): + - Florian da Costa \<\> + - Mourad EL HADJ MIMOUNE \<\> + - Benoît GUILLOT \<\> +- [Eficent](https://www.eficent.com): + - Aaron Henriquez \<\> diff --git a/sql_export/readme/CONTRIBUTORS.rst b/sql_export/readme/CONTRIBUTORS.rst deleted file mode 100644 index 3532281e0..000000000 --- a/sql_export/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,9 +0,0 @@ -* `Akretion `_: - - * Florian da Costa - * Mourad EL HADJ MIMOUNE - * Benoît GUILLOT - -* `Eficent `_: - - * Aaron Henriquez diff --git a/sql_export/readme/DESCRIPTION.md b/sql_export/readme/DESCRIPTION.md new file mode 100644 index 000000000..98c3194ca --- /dev/null +++ b/sql_export/readme/DESCRIPTION.md @@ -0,0 +1,4 @@ +Allow to export data in csv files FROM sql requests. There are some +restrictions in the sql query, you can only read datas. No update, +deletion or creation are possible. A new sub menu named Sql Export is +available in the Dashboard main menu. diff --git a/sql_export/readme/DESCRIPTION.rst b/sql_export/readme/DESCRIPTION.rst deleted file mode 100644 index f1bbef659..000000000 --- a/sql_export/readme/DESCRIPTION.rst +++ /dev/null @@ -1,4 +0,0 @@ -Allow to export data in csv files FROM sql requests. -There are some restrictions in the sql query, you can only read datas. -No update, deletion or creation are possible. -A new sub menu named Sql Export is available in the Dashboard main menu. diff --git a/sql_export/readme/ROADMAP.md b/sql_export/readme/ROADMAP.md new file mode 100644 index 000000000..d47c75986 --- /dev/null +++ b/sql_export/readme/ROADMAP.md @@ -0,0 +1,16 @@ +- Some words are prohibited and can't be used is the query in anyways, + even in a select query: + - delete + - drop + - insert + - alter + - truncate + - execute + - create + - update + +See sql_request_abstract module to fix this issue. + +- checking SQL request by execution and rollback is disabled in this + module since variables features has been introduced. This can be fixed + by overloading \_prepare_request_check_execution() function. diff --git a/sql_export/readme/ROADMAP.rst b/sql_export/readme/ROADMAP.rst deleted file mode 100644 index 22dfa4c8b..000000000 --- a/sql_export/readme/ROADMAP.rst +++ /dev/null @@ -1,16 +0,0 @@ -* Some words are prohibited and can't be used is the query in anyways, even in - a select query: - - delete - - drop - - insert - - alter - - truncate - - execute - - create - - update - -See sql_request_abstract module to fix this issue. - -* checking SQL request by execution and rollback is disabled in this module - since variables features has been introduced. This can be fixed by - overloading _prepare_request_check_execution() function. diff --git a/sql_export/readme/USAGE.md b/sql_export/readme/USAGE.md new file mode 100644 index 000000000..f3026fb8e --- /dev/null +++ b/sql_export/readme/USAGE.md @@ -0,0 +1,8 @@ +Dashboards \> Sql Export + +**Specific use with parameters** + +- %(company_id)s allows to set in the query the company id of the user +- %(user_id)s allows to set in the query the user id +- for any created property, you can use it with %(Property String)s + syntax diff --git a/sql_export/readme/USAGE.rst b/sql_export/readme/USAGE.rst deleted file mode 100644 index 118be5201..000000000 --- a/sql_export/readme/USAGE.rst +++ /dev/null @@ -1,9 +0,0 @@ - -Dashboards > Sql Export - - -**Specific use with parameters** - -- `%(company_id)s` allows to set in the query the company id of the user -- `%(user_id)s` allows to set in the query the user id -- for any created property, you can use it with `%(Property String)s` syntax diff --git a/sql_export/static/description/index.html b/sql_export/static/description/index.html index f0f437882..f7b6869ce 100644 --- a/sql_export/static/description/index.html +++ b/sql_export/static/description/index.html @@ -369,11 +369,11 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:8dd8c4e8b890b9a9f748ec35594cc00c96050977f3b291c1db101a52861d603c !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

-

Allow to export data in csv files FROM sql requests. -There are some restrictions in the sql query, you can only read datas. -No update, deletion or creation are possible. -A new sub menu named Sql Export is available in the Dashboard main menu.

+

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

+

Allow to export data in csv files FROM sql requests. There are some +restrictions in the sql query, you can only read datas. No update, +deletion or creation are possible. A new sub menu named Sql Export is +available in the Dashboard main menu.

Table of contents

    @@ -393,30 +393,33 @@ A new sub menu named Sql Export is available in the Dashboard main menu.

    Dashboards > Sql Export

    Specific use with parameters

      -
    • %(company_id)s allows to set in the query the company id of the user
      • -
    • %(user_id)s allows to set in the query the user id
      • -
    • for any created property, you can use it with %(Property String)s syntax
      • +
    • %(company_id)s allows to set in the query the company id of the user
      • +
    • %(user_id)s allows to set in the query the user id
      • +
    • for any created property, you can use it with %(Property String)s +syntax

Known issues / Roadmap

    -
  • Some words are prohibited and can’t be used is the query in anyways, even in -a select query: -- delete -- drop -- insert -- alter -- truncate -- execute -- create -- update
    • +
  • Some words are prohibited and can’t be used is the query in anyways, +even in a select query:
      +
    • delete
      • +
    • drop
      • +
    • insert
      • +
    • alter
      • +
    • truncate
      • +
    • execute
      • +
    • create
      • +
    • update
      • +
    +

See sql_request_abstract module to fix this issue.

    -
  • checking SQL request by execution and rollback is disabled in this module -since variables features has been introduced. This can be fixed by -overloading _prepare_request_check_execution() function.
    • +
  • checking SQL request by execution and rollback is disabled in this +module since variables features has been introduced. This can be +fixed by overloading _prepare_request_check_execution() function.
@@ -424,7 +427,7 @@ overloading _prepare_request_check_execution() function.

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.

@@ -460,7 +463,7 @@ mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

legalsylvain

-

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.