[IMP] web_notify: pre-commit auto fixes

web_notify/readme/CONTRIBUTORS.md

@@ -0,0 +1,7 @@
+- Laurent Mignon \<<laurent.mignon@acsone.eu>\>
+- Serpent Consulting Services Pvt. Ltd.\<<jay.vora@serpentcs.com>\>
+- Aitor Bouzas \<<aitor.bouzas@adaptivecity.com>\>
+- Shepilov Vladislav \<<shepilov.v@protonmail.com>\>
+- Kevin Khao \<<kevin.khao@akretion.com>\>
+- [Tecnativa](https://www.tecnativa.com):
+  - David Vidal

web_notify/readme/CONTRIBUTORS.rst

@@ -1,8 +0,0 @@
-* Laurent Mignon <laurent.mignon@acsone.eu>
-* Serpent Consulting Services Pvt. Ltd.<jay.vora@serpentcs.com>
-* Aitor Bouzas <aitor.bouzas@adaptivecity.com>
-* Shepilov Vladislav <shepilov.v@protonmail.com>
-* Kevin Khao <kevin.khao@akretion.com>
-* `Tecnativa <https://www.tecnativa.com>`_:
-
-  * David Vidal

web_notify/readme/DESCRIPTION.md

@@ -0,0 +1,11 @@
+Send instant notification messages to the user in live.
+
+This technical module allows you to send instant notification messages
+from the server to the user in live. Two kinds of notification are
+supported.
+
+- Success: Displayed in a success theme color flying popup div
+- Danger: Displayed in a danger theme color flying popup div
+- Warning: Displayed in a warning theme color flying popup div
+- Information: Displayed in a info theme color flying popup div
+- Default: Displayed in a default theme color flying popup div

web_notify/readme/DESCRIPTION.rst

@@ -1,10 +0,0 @@
-Send instant notification messages to the user in live.
-
-This technical module allows you to send instant notification messages from the server to the user in live.
-Two kinds of notification are supported.
-
-* Success: Displayed in a `success` theme color flying popup div
-* Danger: Displayed in a `danger` theme color flying popup div
-* Warning: Displayed in a `warning` theme color flying popup div
-* Information: Displayed in a `info` theme color flying popup div
-* Default: Displayed in a `default` theme color flying popup div

web_notify/readme/INSTALL.md

@@ -1 +1,2 @@
-This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode.
+This module is based on the Instant Messaging Bus. To work properly, the
+server must be launched in gevent mode.

web_notify/readme/USAGE.md

@@ -0,0 +1,62 @@
+To send a notification to the user you just need to call one of the new
+methods defined on res.users:
+
+``` python
+self.env.user.notify_success(message='My success message')
+```
+
+or
+
+``` python
+self.env.user.notify_danger(message='My danger message')
+```
+
+or
+
+``` python
+self.env.user.notify_warning(message='My warning message')
+```
+
+or
+
+``` python
+self.env.user.notify_info(message='My information message')
+```
+
+or
+
+``` python
+self.env.user.notify_default(message='My default message')
+```
+
+The notifications can bring interactivity with some buttons.
+
+- One allowing to refresh the active view
+- Another allowing to send a window / client action
+
+The reload button is activated when sending the notification with:
+
+The action can be used using the `action` keyword and we can choose
+which name to give to our button with the `button_name` key in the
+action context params key:
+
+``` python
+action = self.env["ir.actions.act_window"]._for_xml_id('sale.action_orders')
+action.update({
+   'res_id': self.id,
+   'views': [(False, 'form')],
+})
+action["context"].setdefault("params", {})
+action["context"]["params"]["button_name"] = "Sales"
+action["context"]["params"]["button_icon"] = "fa-eye"
+self.env.user.notify_info('My information message', action=action)
+```
+
+![](../static/img/notifications_screenshot.gif)
+
+You can test the behaviour of the notifications by installing this
+module in a demo database. Access the users form through Settings -\>
+Users & Companies. You'll see a tab called "Test web notify", here
+you'll find two buttons that'll allow you test the module.
+
+![](../static/img/test_notifications_demo.png)

web_notify/readme/USAGE.rst

@@ -1,63 +0,0 @@
-
-To send a notification to the user you just need to call one of the new methods defined on res.users:
-
-.. code-block:: python
-
-   self.env.user.notify_success(message='My success message')
-
-or
-
-.. code-block:: python
-
-   self.env.user.notify_danger(message='My danger message')
-
-or
-
-.. code-block:: python
-
-   self.env.user.notify_warning(message='My warning message')
-
-or
-
-.. code-block:: python
-
-   self.env.user.notify_info(message='My information message')
-
-or
-
-.. code-block:: python
-
-   self.env.user.notify_default(message='My default message')
-
-
-The notifications can bring interactivity with some buttons.
-
-* One allowing to refresh the active view
-* Another allowing to send a window / client action
-
-The reload button is activated when sending the notification with:
-
-The action can be used using the ``action`` keyword and we can choose which name to
-give to our button with the ``button_name`` key in the action context `params` key:
-
-.. code-block:: python
-
-    action = self.env["ir.actions.act_window"]._for_xml_id('sale.action_orders')
-    action.update({
-       'res_id': self.id,
-       'views': [(False, 'form')],
-    })
-    action["context"].setdefault("params", {})
-    action["context"]["params"]["button_name"] = "Sales"
-    action["context"]["params"]["button_icon"] = "fa-eye"
-    self.env.user.notify_info('My information message', action=action)
-
-
-.. figure:: ../static/img/notifications_screenshot.gif
-   :alt: Sample notifications
-
-You can test the behaviour of the notifications by installing this module in a demo database.
-Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module.
-
-.. figure:: ../static/img/test_notifications_demo.png
-   :alt: Sample notifications