[UPD] README.rst

sql_export/README.rst

@@ -7,3 +7,114 @@ SQL Export
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/12.0/sql_export
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-sql_export
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/149/12.0
+    :alt: Try me on Runbot
+
+|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 menu named Export is created.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+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 field with `Sql Export Variables` menu, you can use it with `%(x_field_example)s` syntax 
+  (Limitation for relational fields)
+
+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
+
+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.
+
+* Move modules sql_request_abstract and sql_export to oca/reporting-engine
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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 <https://github.com/OCA/server-tools/issues/new?body=module:%20sql_export%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Akretion
+
+Contributors
+~~~~~~~~~~~~
+
+* `Akretion <https://www.akretion.com>`_:
+
+  * Florian da Costa <florian.dacosta@akretion.com>
+  * Mourad EL HADJ MIMOUNE <mourad.elhadj.mimoune@akretion.com>
+  * Benoît GUILLOT <benoit.guillot@akretion.com>
+
+* `Eficent <https://www.eficent.com>`_:
+
+  * Aaron Henriquez <ahenriquez@eficent.com>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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/server-tools <https://github.com/OCA/server-tools/tree/12.0/sql_export>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.