From 3636851bc1b9ad41ce10bb9e41f7021d9ebfd3b9 Mon Sep 17 00:00:00 2001 From: Anna Janiszewska Date: Mon, 9 Oct 2023 15:27:20 +0200 Subject: [PATCH] ADD readme --- pingen/README.rst | 87 +++-- pingen/readme/CONFIGURE.rst | 5 + pingen/readme/CONTRIBUTORS.rst | 1 + pingen/readme/DESCRIPTION.rst | 7 + pingen/readme/USAGE.rst | 36 ++ pingen/static/description/index.html | 473 +++++++++++++++++++++++++++ 6 files changed, 577 insertions(+), 32 deletions(-) create mode 100644 pingen/readme/CONFIGURE.rst create mode 100644 pingen/readme/CONTRIBUTORS.rst create mode 100644 pingen/readme/DESCRIPTION.rst create mode 100644 pingen/readme/USAGE.rst create mode 100644 pingen/static/description/index.html diff --git a/pingen/README.rst b/pingen/README.rst index 9afa7e03c2a..2bf2f4c43bd 100644 --- a/pingen/README.rst +++ b/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 `_ - * The PDF files sent to pingen.com have to respect some `formatting rules - `_. + * Require the Python library `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 -`_. 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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +~~~~~~~ + +* Camptocamp + Contributors -============ +~~~~~~~~~~~~ + +* Anna Janiszewska -* Guewen Baconnier -* Anar Baghirli -* Akim Juillerat +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/pingen/readme/CONFIGURE.rst b/pingen/readme/CONFIGURE.rst new file mode 100644 index 00000000000..c65a9f24202 --- /dev/null +++ b/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. diff --git a/pingen/readme/CONTRIBUTORS.rst b/pingen/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000000..4124e67fb5c --- /dev/null +++ b/pingen/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Anna Janiszewska diff --git a/pingen/readme/DESCRIPTION.rst b/pingen/readme/DESCRIPTION.rst new file mode 100644 index 00000000000..c851c4a3c1c --- /dev/null +++ b/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. diff --git a/pingen/readme/USAGE.rst b/pingen/readme/USAGE.rst new file mode 100644 index 00000000000..ba1c649c734 --- /dev/null +++ b/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 `_ + * The address must be in a format accepted by pingen.com: the last line + is the country in English or German. diff --git a/pingen/static/description/index.html b/pingen/static/description/index.html new file mode 100644 index 00000000000..26dd5a7abf1 --- /dev/null +++ b/pingen/static/description/index.html @@ -0,0 +1,473 @@ + + + + + + +pingen.com integration + + + +
+

pingen.com integration

+ + +

Beta License: AGPL-3 OCA/report-print-send Translate me on Weblate Try me on Runbot

+

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.

+

Table of contents

+ +
+

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 +(https://stage-api.pingen.com) should be used.

+

Webhooks should be configured on pingen account. Organization ID and webhook secret must match.

+
+
+

Usage

+

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
    • +
  • 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. +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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/report-print-send project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +