ADD readme

pingen/README.rst

@@ -1,35 +1,52 @@
-.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
-   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
-   :alt: License: AGPL-3
-
-===========================
-Integration with pingen.com
-===========================
-
-What is pingen.com
-==================
+======================
+pingen.com integration
+======================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! 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%2Freport--print--send-lightgray.png?logo=github
+    :target: https://github.com/OCA/report-print-send/tree/16.0-mig-pingen/pingen
+    :alt: OCA/report-print-send
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/report-print-send-16-0-mig-pingen/report-print-send-16-0-mig-pingen-pingen
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/144/16.0-mig-pingen
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
 
 Pingen.com is a paid online service.
 It sends uploaded documents by letter post.
 
-Scope of the integration
-========================
-
 One can decide, per document / attachment, if it should be pushed
 to pingen.com. The documents are pushed asynchronously.
 
 The informations of the documents from pingen.com are updated through webhook calls.
 
+**Table of contents**
+
+.. contents::
+   :local:
+
 Configuration
 =============
 
-The authentication token, client ID, organization ID and webhook secret is configured 
-on the company's view. You can also tick a checkbox if the staging environment 
+The authentication token, client ID, organization ID and webhook secret is configured
+on the company's view. You can also tick a checkbox if the staging environment
 (https://stage-api.pingen.com) should be used.
 
 Webhooks should be configured on pingen account. Organization ID and webhook secret must match.
 
-
 Usage
 =====
 
@@ -62,44 +79,50 @@ Pingen Document.
 When a connection error occurs, the action will be retried on the next
 scheduler run.
 
+
 Dependencies
 ============
 
- * Require the Python library `requests <http://docs.python-requests.org/>`_
- * The PDF files sent to pingen.com have to respect some `formatting rules
-   <https://stage-app.pingen.com/resources/pingen_requirements_v1_en.pdf>`_.
+ * Require the Python library `requests_oauthlib <https://github.com/requests/requests-oauthlib>`_
  * The address must be in a format accepted by pingen.com: the last line
    is the country in English or German.
 
 Bug Tracker
 ===========
 
-Bugs are tracked on `GitHub Issues
-<https://github.com/OCA/report-print-send/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.
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/report-print-send/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/report-print-send/issues/new?body=module:%20pingen%0Aversion:%2016.0-mig-pingen%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
+~~~~~~~
+
+* Camptocamp
+
 Contributors
-============
+~~~~~~~~~~~~
+
+* Anna Janiszewska <[email protected]>
 
-* Guewen Baconnier <[email protected]>
-* Anar Baghirli <[email protected]>
-* Akim Juillerat <[email protected]>
+Maintainers
+~~~~~~~~~~~
 
-Maintainer
-==========
+This module is maintained by the OCA.
 
 .. image:: https://odoo-community.org/logo.png
    :alt: Odoo Community Association
    :target: https://odoo-community.org
 
-This module is maintained by the OCA.
-
 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.
 
-To contribute to this module, please visit https://odoo-community.org.
+This module is part of the `OCA/report-print-send <https://github.com/OCA/report-print-send/tree/16.0-mig-pingen/pingen>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

pingen/readme/CONFIGURE.rst

@@ -0,0 +1,5 @@
+The authentication token, client ID, organization ID and webhook secret is configured
+on the company's view. You can also tick a checkbox if the staging environment
+(https://stage-api.pingen.com) should be used.
+
+Webhooks should be configured on pingen account. Organization ID and webhook secret must match.

pingen/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Anna Janiszewska <[email protected]>

pingen/readme/DESCRIPTION.rst

@@ -0,0 +1,7 @@
+Pingen.com is a paid online service.
+It sends uploaded documents by letter post.
+
+One can decide, per document / attachment, if it should be pushed
+to pingen.com. The documents are pushed asynchronously.
+
+The informations of the documents from pingen.com are updated through webhook calls.

pingen/readme/USAGE.rst

@@ -0,0 +1,36 @@
+On the attachment view, a new pingen.com tab has been added.
+You can tick a box to push the document to pingen.com.
+
+There is 3 additional options:
+
+ * Send: the document will not be only uploaded, but will be also be sent
+ * Speed: priority or economy
+ * Type of print: color or black and white
+
+Once the configuration is done and the attachment saved, a Pingen Document
+is created. You can directly access to the latter on the Link on the right on
+the attachment view.
+
+You can find them in `Settings > Customization > Low Level Objets > Pingen
+Documents` or in the more convenient `Documents` menu if you have installed the
+`document` module.
+
+Errors
+======
+
+Sometimes, pingen.com will refuse to send a document because it does not meet
+its requirements. In such case, the document's state becomes "Pingen Error"
+and you will need to manually handle the case, either from the pingen.com
+backend, or by changing the document on OpenERP and resolving the error on the
+Pingen Document.
+
+When a connection error occurs, the action will be retried on the next
+scheduler run.
+
+
+Dependencies
+============
+
+ * Require the Python library `requests_oauthlib <https://github.com/requests/requests-oauthlib>`_
+ * The address must be in a format accepted by pingen.com: the last line
+   is the country in English or German.