From 69acf14b2cec54cde66fdc65ffff6e6ed4fea731 Mon Sep 17 00:00:00 2001 From: hparfr Date: Mon, 16 Dec 2024 18:56:19 +0100 Subject: [PATCH] [IMP] auth_oidc_environment: pre-commit auto fixes --- auth_oidc_environment/README.rst | 30 ++++++++++--------- .../models/auth_oauth_provider.py | 1 - auth_oidc_environment/pyproject.toml | 3 ++ auth_oidc_environment/readme/CONFIGURE.md | 15 ++++++++++ auth_oidc_environment/readme/CONFIGURE.rst | 14 --------- auth_oidc_environment/readme/CONTRIBUTORS.md | 1 + auth_oidc_environment/readme/CONTRIBUTORS.rst | 1 - .../{DESCRIPTION.rst => DESCRIPTION.md} | 0 .../readme/{USAGE.rst => USAGE.md} | 3 +- .../static/description/index.html | 30 +++++++++++-------- 10 files changed, 54 insertions(+), 44 deletions(-) create mode 100644 auth_oidc_environment/pyproject.toml create mode 100644 auth_oidc_environment/readme/CONFIGURE.md delete mode 100644 auth_oidc_environment/readme/CONFIGURE.rst create mode 100644 auth_oidc_environment/readme/CONTRIBUTORS.md delete mode 100644 auth_oidc_environment/readme/CONTRIBUTORS.rst rename auth_oidc_environment/readme/{DESCRIPTION.rst => DESCRIPTION.md} (100%) rename auth_oidc_environment/readme/{USAGE.rst => USAGE.md} (78%) diff --git a/auth_oidc_environment/README.rst b/auth_oidc_environment/README.rst index e3ffc623d6..852a4c2ae5 100644 --- a/auth_oidc_environment/README.rst +++ b/auth_oidc_environment/README.rst @@ -17,13 +17,13 @@ Auth Oidc Environment :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--auth-lightgray.png?logo=github - :target: https://github.com/OCA/server-auth/tree/16.0/auth_oidc_environment + :target: https://github.com/OCA/server-auth/tree/18.0/auth_oidc_environment :alt: OCA/server-auth .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/server-auth-16-0/server-auth-16-0-auth_oidc_environment + :target: https://translation.odoo-community.org/projects/server-auth-18-0/server-auth-18-0-auth_oidc_environment :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/server-auth&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-auth&target_branch=18.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| @@ -40,23 +40,25 @@ Configuration To configure this module, you need to: -Create a module server_environment_file with a cfg file or set the environment variable SERVER_ENV_CONFIG with the following section: +Create a module server_environment_file with a cfg file or set the +environment variable SERVER_ENV_CONFIG with the following section: [auth_oauth_provider.] -Where is optional and must be equal to the name field you defined in Odoo for the IDP. +Where is optional and must be equal to the name field you defined +in Odoo for the IDP. Example of configuration [auth_oauth_provider.azure] -client_id=... -client_secret=... +client_id=... client_secret=... Usage ===== -Once configured, Odoo will read the Auth Providers values from the configuration. +Once configured, Odoo will read the Auth Providers values from the +configuration. Bug Tracker =========== @@ -64,7 +66,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. @@ -72,17 +74,17 @@ Credits ======= Authors -~~~~~~~ +------- * ACSONE SA/NV Contributors -~~~~~~~~~~~~ +------------ -* Adrien PEIFFER (ACSONE SA/NV) +- Adrien PEIFFER (ACSONE SA/NV) Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -94,6 +96,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/server-auth `_ project on GitHub. +This module is part of the `OCA/server-auth `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/auth_oidc_environment/models/auth_oauth_provider.py b/auth_oidc_environment/models/auth_oauth_provider.py index 5b27d697cc..40f6821cbe 100644 --- a/auth_oidc_environment/models/auth_oauth_provider.py +++ b/auth_oidc_environment/models/auth_oauth_provider.py @@ -5,7 +5,6 @@ class AuthOauthProvider(models.Model): - _name = "auth.oauth.provider" _inherit = ["auth.oauth.provider", "server.env.mixin"] diff --git a/auth_oidc_environment/pyproject.toml b/auth_oidc_environment/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/auth_oidc_environment/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/auth_oidc_environment/readme/CONFIGURE.md b/auth_oidc_environment/readme/CONFIGURE.md new file mode 100644 index 0000000000..3ab09897d0 --- /dev/null +++ b/auth_oidc_environment/readme/CONFIGURE.md @@ -0,0 +1,15 @@ +To configure this module, you need to: + +Create a module server_environment_file with a cfg file or set the +environment variable SERVER_ENV_CONFIG with the following section: + +\[auth_oauth_provider.\\] + +Where \ is optional and must be equal to the name field you +defined in Odoo for the IDP. + +Example of configuration + +\[auth_oauth_provider.azure\] + +client_id=... client_secret=... diff --git a/auth_oidc_environment/readme/CONFIGURE.rst b/auth_oidc_environment/readme/CONFIGURE.rst deleted file mode 100644 index 2a5f19b7dc..0000000000 --- a/auth_oidc_environment/readme/CONFIGURE.rst +++ /dev/null @@ -1,14 +0,0 @@ -To configure this module, you need to: - -Create a module server_environment_file with a cfg file or set the environment variable SERVER_ENV_CONFIG with the following section: - -[auth_oauth_provider.] - -Where is optional and must be equal to the name field you defined in Odoo for the IDP. - -Example of configuration - -[auth_oauth_provider.azure] - -client_id=... -client_secret=... diff --git a/auth_oidc_environment/readme/CONTRIBUTORS.md b/auth_oidc_environment/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..8eb2ae4a80 --- /dev/null +++ b/auth_oidc_environment/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Adrien PEIFFER \<\> (ACSONE SA/NV) diff --git a/auth_oidc_environment/readme/CONTRIBUTORS.rst b/auth_oidc_environment/readme/CONTRIBUTORS.rst deleted file mode 100644 index 51c4cccb67..0000000000 --- a/auth_oidc_environment/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1 +0,0 @@ -* Adrien PEIFFER (ACSONE SA/NV) diff --git a/auth_oidc_environment/readme/DESCRIPTION.rst b/auth_oidc_environment/readme/DESCRIPTION.md similarity index 100% rename from auth_oidc_environment/readme/DESCRIPTION.rst rename to auth_oidc_environment/readme/DESCRIPTION.md diff --git a/auth_oidc_environment/readme/USAGE.rst b/auth_oidc_environment/readme/USAGE.md similarity index 78% rename from auth_oidc_environment/readme/USAGE.rst rename to auth_oidc_environment/readme/USAGE.md index 80beac94bc..f4ed3f7ad7 100644 --- a/auth_oidc_environment/readme/USAGE.rst +++ b/auth_oidc_environment/readme/USAGE.md @@ -1 +1,2 @@ -Once configured, Odoo will read the Auth Providers values from the configuration. +Once configured, Odoo will read the Auth Providers values from the +configuration. diff --git a/auth_oidc_environment/static/description/index.html b/auth_oidc_environment/static/description/index.html index bdde833938..08cf0a63e2 100644 --- a/auth_oidc_environment/static/description/index.html +++ b/auth_oidc_environment/static/description/index.html @@ -1,4 +1,3 @@ - @@ -9,10 +8,11 @@ /* :Author: David Goodger (goodger@python.org) -:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $ +:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $ :Copyright: This stylesheet has been placed in the public domain. Default cascading style sheet for the HTML output of Docutils. +Despite the name, some widely supported CSS2 features are used. See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to customize this style sheet. @@ -275,7 +275,7 @@ margin-left: 2em ; margin-right: 2em } -pre.code .ln { color: grey; } /* line numbers */ +pre.code .ln { color: gray; } /* line numbers */ pre.code, code { background-color: #eeeeee } pre.code .comment, code .comment { color: #5C6576 } pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } @@ -301,7 +301,7 @@ span.pre { white-space: pre } -span.problematic { +span.problematic, pre.problematic { color: red } span.section-subtitle { @@ -369,7 +369,7 @@

Auth Oidc Environment

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:18aa5a39b1804e3212b277bcc74b32f2297dca10bf1d3192c5fd659082b81150 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/server-auth Translate me on Weblate Try me on Runboat

+

Beta License: AGPL-3 OCA/server-auth Translate me on Weblate Try me on Runboat

this module allows to use server env for OIDC configuration

Table of contents

@@ -388,24 +388,26 @@

Auth Oidc Environment

Configuration

To configure this module, you need to:

-

Create a module server_environment_file with a cfg file or set the environment variable SERVER_ENV_CONFIG with the following section:

+

Create a module server_environment_file with a cfg file or set the +environment variable SERVER_ENV_CONFIG with the following section:

[auth_oauth_provider.<name>]

-

Where <name> is optional and must be equal to the name field you defined in Odoo for the IDP.

+

Where <name> is optional and must be equal to the name field you defined +in Odoo for the IDP.

Example of configuration

[auth_oauth_provider.azure]

-

client_id=… -client_secret=…

+

client_id=… client_secret=…

Usage

-

Once configured, Odoo will read the Auth Providers values from the configuration.

+

Once configured, Odoo will read the Auth Providers values from the +configuration.

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.

@@ -425,11 +427,13 @@

Contributors

Maintainers

This module is maintained by the OCA.

-Odoo Community Association + +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/server-auth project on GitHub.

+

This module is part of the OCA/server-auth project on GitHub.

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