From c19c5f9cb190511f65430d88892fa0a0b3633578 Mon Sep 17 00:00:00 2001 From: Enric Tobella Date: Tue, 17 Dec 2024 12:10:38 +0100 Subject: [PATCH] [IMP] account_statement_import_online_gocardless: black, isort, prettier --- .../README.rst | 130 ++++++++++-------- .../pyproject.toml | 3 + .../readme/CONFIGURE.md | 51 +++++++ .../readme/CONFIGURE.rst | 42 ------ .../readme/CONTRIBUTORS.md | 7 + .../readme/CONTRIBUTORS.rst | 10 -- .../readme/DESCRIPTION.md | 3 + .../readme/DESCRIPTION.rst | 3 - .../readme/USAGE.md | 10 ++ .../readme/USAGE.rst | 10 -- .../static/description/index.html | 54 ++++---- 11 files changed, 176 insertions(+), 147 deletions(-) create mode 100644 account_statement_import_online_gocardless/pyproject.toml create mode 100644 account_statement_import_online_gocardless/readme/CONFIGURE.md delete mode 100644 account_statement_import_online_gocardless/readme/CONFIGURE.rst create mode 100644 account_statement_import_online_gocardless/readme/CONTRIBUTORS.md delete mode 100644 account_statement_import_online_gocardless/readme/CONTRIBUTORS.rst create mode 100644 account_statement_import_online_gocardless/readme/DESCRIPTION.md delete mode 100644 account_statement_import_online_gocardless/readme/DESCRIPTION.rst create mode 100644 account_statement_import_online_gocardless/readme/USAGE.md delete mode 100644 account_statement_import_online_gocardless/readme/USAGE.rst diff --git a/account_statement_import_online_gocardless/README.rst b/account_statement_import_online_gocardless/README.rst index 1d00bf1d..15847fab 100644 --- a/account_statement_import_online_gocardless/README.rst +++ b/account_statement_import_online_gocardless/README.rst @@ -17,20 +17,20 @@ Online Bank Statements: GoCardless :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fbank--statement--import-lightgray.png?logo=github - :target: https://github.com/OCA/bank-statement-import/tree/16.0/account_statement_import_online_gocardless + :target: https://github.com/OCA/bank-statement-import/tree/17.0/account_statement_import_online_gocardless :alt: OCA/bank-statement-import .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/bank-statement-import-16-0/bank-statement-import-16-0-account_statement_import_online_gocardless + :target: https://translation.odoo-community.org/projects/bank-statement-import-17-0/bank-statement-import-17-0-account_statement_import_online_gocardless :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/bank-statement-import&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| -This module provides online bank statements from GoCardless Bank Account Data, -which provides a free API for connecting and getting transactions for bank -accounts. +This module provides online bank statements from GoCardless Bank Account +Data, which provides a free API for connecting and getting transactions +for bank accounts. **Table of contents** @@ -41,61 +41,76 @@ Configuration ============= On the GoCardless website -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- -#. Go to https://bankaccountdata.gocardless.com, and create or login into your - "GoCardLess Bank Account Data" account. -#. Go to Developers > User secrets option on the left. -#. Click on the "+ Create new" button on the bottom part. -#. Put a name to the user secret (eg. Odoo), and optionally limit it to certain - IPs using CIDR subnet notation. -#. Copy or download the secret ID and key for later use. The second one won't be - available anymore, so make sure you don't forget this step. +1. Go to + `https://bankaccountdata.gocardless.com `__, + and create or login into your "GoCardLess Bank Account Data" account. +2. Go to Developers > User secrets option on the left. +3. Click on the "+ Create new" button on the bottom part. +4. Put a name to the user secret (eg. Odoo), and optionally limit it to + certain IPs using CIDR subnet notation. +5. Copy or download the secret ID and key for later use. The second one + won't be available anymore, so make sure you don't forget this step. On Odoo -~~~~~~~ +------- To configure online bank statements provider: -#. Add your user to the "Full Accounting Settings" group. -#. Go to *Invoicing > Configuration > Accounting > Journals*. -#. Select the journal representing your bank account (or create it). -#. The bank account number should be properly introduced. -#. Set *Bank Feeds* to *Online (OCA)*. -#. Select *GoCardless* as online bank statements provider in - *Online Bank Statements (OCA)* section. -#. Save the journal -#. Click on the created provider. -#. Put your secret ID and secret key on the existing fields. -#. Click on the button "Select Bank Account Identifier". +1. Add your user to the "Full Accounting Settings" group. - .. image:: https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif +2. Go to *Invoicing > Configuration > Accounting > Journals*. -#. A new window will appear for selecting the bank entity. +3. Select the journal representing your bank account (or create it). - .. image:: https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif +4. The bank account number should be properly introduced. -#. Select it, and you will be redirected to the selected entity for introducing - your bank credentials to allow the connection. -#. If the process is completed, and the bank account linked to the journal is - accessible, you'll be again redirected to the online provider form, and - everything will be linked and ready to start the transaction pulling. A - message is logged about it on the chatter. -#. If not, an error message will be logged either in the chatter. +5. Set *Bank Feeds* to *Online (OCA)*. + +6. Select *GoCardless* as online bank statements provider in *Online + Bank Statements (OCA)* section. + +7. Save the journal + +8. Click on the created provider. + +9. Put your secret ID and secret key on the existing fields. + +10. Click on the button "Select Bank Account Identifier". + + |image_01| + +11. A new window will appear for selecting the bank entity. + + |image_02| + +12. Select it, and you will be redirected to the selected entity for + introducing your bank credentials to allow the connection. + +13. If the process is completed, and the bank account linked to the + journal is accessible, you'll be again redirected to the online + provider form, and everything will be linked and ready to start the + transaction pulling. A message is logged about it on the chatter. + +14. If not, an error message will be logged either in the chatter. + +.. |image_01| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif +.. |image_02| image:: https://raw.githubusercontent.com/OCA/bank-statement-import/17.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif Usage ===== To pull historical bank statements: -#. Go to *Invoicing > Configuration > Accounting > Journals*. -#. Select the journal representing your bank account. -#. Launch *Actions > Online Bank Statements Pull Wizard* -#. Configure date interval and click on *Pull*. +1. Go to *Invoicing > Configuration > Accounting > Journals*. +2. Select the journal representing your bank account. +3. Launch *Actions > Online Bank Statements Pull Wizard* +4. Configure date interval and click on *Pull*. -If historical data is not needed, then just simply wait for the scheduled -activity "Pull Online Bank Statements" to be executed for getting new -transactions. +If historical data is not needed, then just simply wait for the +scheduled activity "Pull Online Bank Statements" to be executed for +getting new transactions. Bug Tracker =========== @@ -103,7 +118,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. @@ -111,27 +126,30 @@ Credits ======= Authors -~~~~~~~ +------- * ForgeFlow * Tecnativa Contributors -~~~~~~~~~~~~ +------------ -* `ForgeFlow `__: +- `ForgeFlow `__: - * Christopher Ormaza - * Jordi Ballester -* `Tecnativa `__: + - Christopher Ormaza + - Jordi Ballester - * Pedro M. Baeza -* `Alusage `__: +- `Tecnativa `__: - * Nicolas JEUDY + - Pedro M. Baeza + +- `Alusage `__: + + - Nicolas JEUDY + <`https://github.com/njeudy `__> Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -143,6 +161,6 @@ 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/bank-statement-import `_ project on GitHub. +This module is part of the `OCA/bank-statement-import `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/account_statement_import_online_gocardless/pyproject.toml b/account_statement_import_online_gocardless/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/account_statement_import_online_gocardless/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/account_statement_import_online_gocardless/readme/CONFIGURE.md b/account_statement_import_online_gocardless/readme/CONFIGURE.md new file mode 100644 index 00000000..32e37549 --- /dev/null +++ b/account_statement_import_online_gocardless/readme/CONFIGURE.md @@ -0,0 +1,51 @@ +## On the GoCardless website + +1. Go to , and create or login + into your "GoCardLess Bank Account Data" account. +2. Go to Developers \> User secrets option on the left. +3. Click on the "+ Create new" button on the bottom part. +4. Put a name to the user secret (eg. Odoo), and optionally limit it to + certain IPs using CIDR subnet notation. +5. Copy or download the secret ID and key for later use. The second one + won't be available anymore, so make sure you don't forget this step. + +## On Odoo + +To configure online bank statements provider: + +1. Add your user to the "Full Accounting Settings" group. + +2. Go to *Invoicing \> Configuration \> Accounting \> Journals*. + +3. Select the journal representing your bank account (or create it). + +4. The bank account number should be properly introduced. + +5. Set *Bank Feeds* to *Online (OCA)*. + +6. Select *GoCardless* as online bank statements provider in *Online + Bank Statements (OCA)* section. + +7. Save the journal + +8. Click on the created provider. + +9. Put your secret ID and secret key on the existing fields. + +10. Click on the button "Select Bank Account Identifier". + + ![image_01](../static/img/gocardless_configuration.gif) + +11. A new window will appear for selecting the bank entity. + + ![image_02](../static/img/gocardless_bank_selection.gif) + +12. Select it, and you will be redirected to the selected entity for + introducing your bank credentials to allow the connection. + +13. If the process is completed, and the bank account linked to the + journal is accessible, you'll be again redirected to the online + provider form, and everything will be linked and ready to start the + transaction pulling. A message is logged about it on the chatter. + +14. If not, an error message will be logged either in the chatter. diff --git a/account_statement_import_online_gocardless/readme/CONFIGURE.rst b/account_statement_import_online_gocardless/readme/CONFIGURE.rst deleted file mode 100644 index 174499fc..00000000 --- a/account_statement_import_online_gocardless/readme/CONFIGURE.rst +++ /dev/null @@ -1,42 +0,0 @@ -On the GoCardless website -~~~~~~~~~~~~~~~~~~~~~~~~~ - -#. Go to https://bankaccountdata.gocardless.com, and create or login into your - "GoCardLess Bank Account Data" account. -#. Go to Developers > User secrets option on the left. -#. Click on the "+ Create new" button on the bottom part. -#. Put a name to the user secret (eg. Odoo), and optionally limit it to certain - IPs using CIDR subnet notation. -#. Copy or download the secret ID and key for later use. The second one won't be - available anymore, so make sure you don't forget this step. - -On Odoo -~~~~~~~ - -To configure online bank statements provider: - -#. Add your user to the "Full Accounting Settings" group. -#. Go to *Invoicing > Configuration > Accounting > Journals*. -#. Select the journal representing your bank account (or create it). -#. The bank account number should be properly introduced. -#. Set *Bank Feeds* to *Online (OCA)*. -#. Select *GoCardless* as online bank statements provider in - *Online Bank Statements (OCA)* section. -#. Save the journal -#. Click on the created provider. -#. Put your secret ID and secret key on the existing fields. -#. Click on the button "Select Bank Account Identifier". - - .. image:: ../static/img/gocardless_configuration.gif - -#. A new window will appear for selecting the bank entity. - - .. image:: ../static/img/gocardless_bank_selection.gif - -#. Select it, and you will be redirected to the selected entity for introducing - your bank credentials to allow the connection. -#. If the process is completed, and the bank account linked to the journal is - accessible, you'll be again redirected to the online provider form, and - everything will be linked and ready to start the transaction pulling. A - message is logged about it on the chatter. -#. If not, an error message will be logged either in the chatter. diff --git a/account_statement_import_online_gocardless/readme/CONTRIBUTORS.md b/account_statement_import_online_gocardless/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..5d233fd8 --- /dev/null +++ b/account_statement_import_online_gocardless/readme/CONTRIBUTORS.md @@ -0,0 +1,7 @@ + - [ForgeFlow](https://www.forgeflow.com): + - Christopher Ormaza + - Jordi Ballester + - [Tecnativa](https://www.tecnativa.com): + - Pedro M. Baeza + - [Alusage](https://nicolas.alusage.fr): + - Nicolas JEUDY \<\> diff --git a/account_statement_import_online_gocardless/readme/CONTRIBUTORS.rst b/account_statement_import_online_gocardless/readme/CONTRIBUTORS.rst deleted file mode 100644 index a7d7525e..00000000 --- a/account_statement_import_online_gocardless/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,10 +0,0 @@ -* `ForgeFlow `__: - - * Christopher Ormaza - * Jordi Ballester -* `Tecnativa `__: - - * Pedro M. Baeza -* `Alusage `__: - - * Nicolas JEUDY diff --git a/account_statement_import_online_gocardless/readme/DESCRIPTION.md b/account_statement_import_online_gocardless/readme/DESCRIPTION.md new file mode 100644 index 00000000..d170cdb3 --- /dev/null +++ b/account_statement_import_online_gocardless/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module provides online bank statements from GoCardless Bank Account +Data, which provides a free API for connecting and getting transactions +for bank accounts. diff --git a/account_statement_import_online_gocardless/readme/DESCRIPTION.rst b/account_statement_import_online_gocardless/readme/DESCRIPTION.rst deleted file mode 100644 index 2572d99a..00000000 --- a/account_statement_import_online_gocardless/readme/DESCRIPTION.rst +++ /dev/null @@ -1,3 +0,0 @@ -This module provides online bank statements from GoCardless Bank Account Data, -which provides a free API for connecting and getting transactions for bank -accounts. diff --git a/account_statement_import_online_gocardless/readme/USAGE.md b/account_statement_import_online_gocardless/readme/USAGE.md new file mode 100644 index 00000000..97f15506 --- /dev/null +++ b/account_statement_import_online_gocardless/readme/USAGE.md @@ -0,0 +1,10 @@ +To pull historical bank statements: + +1. Go to *Invoicing \> Configuration \> Accounting \> Journals*. +2. Select the journal representing your bank account. +3. Launch *Actions \> Online Bank Statements Pull Wizard* +4. Configure date interval and click on *Pull*. + +If historical data is not needed, then just simply wait for the +scheduled activity "Pull Online Bank Statements" to be executed for +getting new transactions. diff --git a/account_statement_import_online_gocardless/readme/USAGE.rst b/account_statement_import_online_gocardless/readme/USAGE.rst deleted file mode 100644 index 485621b0..00000000 --- a/account_statement_import_online_gocardless/readme/USAGE.rst +++ /dev/null @@ -1,10 +0,0 @@ -To pull historical bank statements: - -#. Go to *Invoicing > Configuration > Accounting > Journals*. -#. Select the journal representing your bank account. -#. Launch *Actions > Online Bank Statements Pull Wizard* -#. Configure date interval and click on *Pull*. - -If historical data is not needed, then just simply wait for the scheduled -activity "Pull Online Bank Statements" to be executed for getting new -transactions. diff --git a/account_statement_import_online_gocardless/static/description/index.html b/account_statement_import_online_gocardless/static/description/index.html index 54b0566a..f0d73481 100644 --- a/account_statement_import_online_gocardless/static/description/index.html +++ b/account_statement_import_online_gocardless/static/description/index.html @@ -369,10 +369,10 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:86c3a6944d510b258d44f2a74e4e9e433cb0e4f9745ca156414b7a5c0d83efb1 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/bank-statement-import Translate me on Weblate Try me on Runboat

-

This module provides online bank statements from GoCardless Bank Account Data, -which provides a free API for connecting and getting transactions for bank -accounts.

+

Beta License: AGPL-3 OCA/bank-statement-import Translate me on Weblate Try me on Runboat

+

This module provides online bank statements from GoCardless Bank Account +Data, which provides a free API for connecting and getting transactions +for bank accounts.

Table of contents

    @@ -396,14 +396,15 @@ accounts.

    On the GoCardless website

      -
    1. Go to https://bankaccountdata.gocardless.com, and create or login into your -“GoCardLess Bank Account Data” account.
      2. +
    2. Go to +https://bankaccountdata.gocardless.com, +and create or login into your “GoCardLess Bank Account Data” account.
    3. Go to Developers > User secrets option on the left.
    4. Click on the “+ Create new” button on the bottom part.
      5. -
    5. Put a name to the user secret (eg. Odoo), and optionally limit it to certain -IPs using CIDR subnet notation.
      6. -
    6. Copy or download the secret ID and key for later use. The second one won’t be -available anymore, so make sure you don’t forget this step.
      7. +
    7. Put a name to the user secret (eg. Odoo), and optionally limit it to +certain IPs using CIDR subnet notation.
      8. +
    8. Copy or download the secret ID and key for later use. The second one +won’t be available anymore, so make sure you don’t forget this step.
    @@ -420,8 +421,8 @@ available anymore, so make sure you don’t forget this step.

  • Set Bank Feeds to Online (OCA).

    • -

  • Select GoCardless as online bank statements provider in -Online Bank Statements (OCA) section.

    +

  • Select GoCardless as online bank statements provider in Online +Bank Statements (OCA) section.

  • Save the journal

    • @@ -430,18 +431,18 @@ available anymore, so make sure you don’t forget this step.

  • Put your secret ID and secret key on the existing fields.

  • Click on the button “Select Bank Account Identifier”.

    -https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_configuration.gif +

    image_01

  • A new window will appear for selecting the bank entity.

    -https://raw.githubusercontent.com/OCA/bank-statement-import/16.0/account_statement_import_online_gocardless/static/img/gocardless_bank_selection.gif +

    image_02

    • -

  • Select it, and you will be redirected to the selected entity for introducing -your bank credentials to allow the connection.

    +

  • Select it, and you will be redirected to the selected entity for +introducing your bank credentials to allow the connection.

    • -

  • If the process is completed, and the bank account linked to the journal is -accessible, you’ll be again redirected to the online provider form, and -everything will be linked and ready to start the transaction pulling. A -message is logged about it on the chatter.

    +

  • If the process is completed, and the bank account linked to the +journal is accessible, you’ll be again redirected to the online +provider form, and everything will be linked and ready to start the +transaction pulling. A message is logged about it on the chatter.

  • If not, an error message will be logged either in the chatter.

    • @@ -457,16 +458,16 @@ message is logged about it on the chatter.

  • Launch Actions > Online Bank Statements Pull Wizard
  • Configure date interval and click on Pull.
    • -

    If historical data is not needed, then just simply wait for the scheduled -activity “Pull Online Bank Statements” to be executed for getting new -transactions.

    +

    If historical data is not needed, then just simply wait for the +scheduled activity “Pull Online Bank Statements” to be executed for +getting new transactions.

    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.

    @@ -491,7 +492,8 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
  • Alusage:
    • @@ -505,7 +507,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

    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/bank-statement-import project on GitHub.

    +

    This module is part of the OCA/bank-statement-import project on GitHub.

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