[IMP] server_environment_ir_config_parameter: pre-commit stuff

This commit is contained in:
Marcos Oitaben 2023-11-13 09:43:35 +01:00
parent 2305c025bb
commit 688ad644a2
13 changed files with 76 additions and 70 deletions

View File

@ -17,13 +17,13 @@ Server Environment Ir Config Parameter
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3 :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github
:target: https://github.com/OCA/server-env/tree/16.0/server_environment_ir_config_parameter :target: https://github.com/OCA/server-env/tree/17.0/server_environment_ir_config_parameter
:alt: OCA/server-env :alt: OCA/server-env
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-env-16-0/server-env-16-0-server_environment_ir_config_parameter :target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-server_environment_ir_config_parameter
:alt: Translate me on Weblate :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=16.0 :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=17.0
:alt: Try me on Runboat :alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5| |badge1| |badge2| |badge3| |badge4| |badge5|
@ -38,20 +38,22 @@ Override System Parameters from server environment file.
Configuration Configuration
============= =============
To configure this module, you need to add a section ``[ir.config_parameter]`` to To configure this module, you need to add a section
you server_environment_files configurations, where the keys are the same ``[ir.config_parameter]`` to you server_environment_files
as would normally be set in the Systems Parameter Odoo menu. configurations, where the keys are the same as would normally be set in
the Systems Parameter Odoo menu.
When first using a value, the system will read it from the configuration file When first using a value, the system will read it from the configuration
and override any value that would be present in the database, so the configuration file and override any value that would be present in the database, so
file has precedence. the configuration file has precedence.
When creating or modifying values that are in the configuration file, the When creating or modifying values that are in the configuration file,
module replace changes, enforcing the configuration value. the module replace changes, enforcing the configuration value.
For example you can use this module in combination with web_environment_ribbon: For example you can use this module in combination with
web_environment_ribbon:
.. code:: ::
[ir.config_parameter] [ir.config_parameter]
ribbon.name=DEV ribbon.name=DEV
@ -67,8 +69,8 @@ Known issues / Roadmap
When the user modifies System Parameters that are defined in the config When the user modifies System Parameters that are defined in the config
file, the changes are ignored. It would be nice to display which system file, the changes are ignored. It would be nice to display which system
parameters come from the config file and possibly make their key and value parameters come from the config file and possibly make their key and
readonly in the user interface. value readonly in the user interface.
Bug Tracker Bug Tracker
=========== ===========
@ -76,7 +78,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_ir_config_parameter%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. `feedback <https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_ir_config_parameter%0Aversion:%2017.0%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. Do not contact contributors directly about support or help with technical issues.
@ -84,26 +86,25 @@ Credits
======= =======
Authors Authors
~~~~~~~ -------
* ACSONE SA/NV * ACSONE SA/NV
Contributors Contributors
~~~~~~~~~~~~ ------------
* Stéphane Bidoul <stephane.bidoul@acsone.eu> (https://acsone.eu) - Stéphane Bidoul <stephane.bidoul@acsone.eu> (https://acsone.eu)
* Thierry Ducrest <thierry.ducrest@camptocamp.com> - Thierry Ducrest <thierry.ducrest@camptocamp.com>
* Gilles Meyomesse <gilles.meyomesse@acsone.eu> (https://acsone.eu) - Gilles Meyomesse <gilles.meyomesse@acsone.eu> (https://acsone.eu)
* Sylvain LE GAL (https://www.twitter.com/legalsylvain) - Sylvain LE GAL (https://www.twitter.com/legalsylvain)
Other credits Other credits
~~~~~~~~~~~~~ -------------
This module is maintained by: This module is maintained by: \* Odoo Community Association
* Odoo Community Association
Maintainers Maintainers
~~~~~~~~~~~ -----------
This module is maintained by the OCA. This module is maintained by the OCA.
@ -115,6 +116,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/16.0/server_environment_ir_config_parameter>`_ project on GitHub. This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/17.0/server_environment_ir_config_parameter>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

View File

@ -10,7 +10,6 @@ SECTION = "ir.config_parameter"
class IrConfigParameter(models.Model): class IrConfigParameter(models.Model):
_inherit = "ir.config_parameter" _inherit = "ir.config_parameter"
is_environment = fields.Boolean( is_environment = fields.Boolean(

View File

@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"

View File

@ -0,0 +1,19 @@
To configure this module, you need to add a section
`[ir.config_parameter]` to you server_environment_files configurations,
where the keys are the same as would normally be set in the Systems
Parameter Odoo menu.
When first using a value, the system will read it from the configuration
file and override any value that would be present in the database, so
the configuration file has precedence.
When creating or modifying values that are in the configuration file,
the module replace changes, enforcing the configuration value.
For example you can use this module in combination with
web_environment_ribbon:
```
[ir.config_parameter]
ribbon.name=DEV
```

View File

@ -1,17 +0,0 @@
To configure this module, you need to add a section ``[ir.config_parameter]`` to
you server_environment_files configurations, where the keys are the same
as would normally be set in the Systems Parameter Odoo menu.
When first using a value, the system will read it from the configuration file
and override any value that would be present in the database, so the configuration
file has precedence.
When creating or modifying values that are in the configuration file, the
module replace changes, enforcing the configuration value.
For example you can use this module in combination with web_environment_ribbon:
.. code::
[ir.config_parameter]
ribbon.name=DEV

View File

@ -0,0 +1,5 @@
- Stéphane Bidoul \<<stephane.bidoul@acsone.eu>\> (<https://acsone.eu>)
- Thierry Ducrest \<<thierry.ducrest@camptocamp.com>\>
- Gilles Meyomesse \<<gilles.meyomesse@acsone.eu>\>
(<https://acsone.eu>)
- Sylvain LE GAL (<https://www.twitter.com/legalsylvain>)

View File

@ -1,4 +0,0 @@
* Stéphane Bidoul <stephane.bidoul@acsone.eu> (https://acsone.eu)
* Thierry Ducrest <thierry.ducrest@camptocamp.com>
* Gilles Meyomesse <gilles.meyomesse@acsone.eu> (https://acsone.eu)
* Sylvain LE GAL (https://www.twitter.com/legalsylvain)

View File

@ -0,0 +1 @@
This module is maintained by: \* Odoo Community Association

View File

@ -1,2 +0,0 @@
This module is maintained by:
* Odoo Community Association

View File

@ -1,4 +1,4 @@
When the user modifies System Parameters that are defined in the config When the user modifies System Parameters that are defined in the config
file, the changes are ignored. It would be nice to display which system file, the changes are ignored. It would be nice to display which system
parameters come from the config file and possibly make their key and value parameters come from the config file and possibly make their key and
readonly in the user interface. value readonly in the user interface.

View File

@ -369,7 +369,7 @@ ul.auto-toc {
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:29c97aeb304203d7c075a8ff1295720253ea06b1f8d4fc57ef0fa71b45f3a38b !! source digest: sha256:29c97aeb304203d7c075a8ff1295720253ea06b1f8d4fc57ef0fa71b45f3a38b
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-env/tree/16.0/server_environment_ir_config_parameter"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-env-16-0/server-env-16-0-server_environment_ir_config_parameter"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-env&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p> <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/server-env/tree/17.0/server_environment_ir_config_parameter"><img alt="OCA/server-env" src="https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-server_environment_ir_config_parameter"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/server-env&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>Override System Parameters from server environment file.</p> <p>Override System Parameters from server environment file.</p>
<p><strong>Table of contents</strong></p> <p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents"> <div class="contents local topic" id="contents">
@ -389,16 +389,18 @@ ul.auto-toc {
</div> </div>
<div class="section" id="configuration"> <div class="section" id="configuration">
<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1> <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
<p>To configure this module, you need to add a section <tt class="docutils literal">[ir.config_parameter]</tt> to <p>To configure this module, you need to add a section
you server_environment_files configurations, where the keys are the same <tt class="docutils literal">[ir.config_parameter]</tt> to you server_environment_files
as would normally be set in the Systems Parameter Odoo menu.</p> configurations, where the keys are the same as would normally be set in
<p>When first using a value, the system will read it from the configuration file the Systems Parameter Odoo menu.</p>
and override any value that would be present in the database, so the configuration <p>When first using a value, the system will read it from the configuration
file has precedence.</p> file and override any value that would be present in the database, so
<p>When creating or modifying values that are in the configuration file, the the configuration file has precedence.</p>
module replace changes, enforcing the configuration value.</p> <p>When creating or modifying values that are in the configuration file,
<p>For example you can use this module in combination with web_environment_ribbon:</p> the module replace changes, enforcing the configuration value.</p>
<pre class="code literal-block"> <p>For example you can use this module in combination with
web_environment_ribbon:</p>
<pre class="literal-block">
[ir.config_parameter] [ir.config_parameter]
ribbon.name=DEV ribbon.name=DEV
</pre> </pre>
@ -412,15 +414,15 @@ server_environment module.</p>
<h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1> <h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
<p>When the user modifies System Parameters that are defined in the config <p>When the user modifies System Parameters that are defined in the config
file, the changes are ignored. It would be nice to display which system file, the changes are ignored. It would be nice to display which system
parameters come from the config file and possibly make their key and value parameters come from the config file and possibly make their key and
readonly in the user interface.</p> value readonly in the user interface.</p>
</div> </div>
<div class="section" id="bug-tracker"> <div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1> <h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-env/issues">GitHub Issues</a>. <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-env/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported. 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 If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_ir_config_parameter%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <a class="reference external" href="https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_ir_config_parameter%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
@ -442,8 +444,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
</div> </div>
<div class="section" id="other-credits"> <div class="section" id="other-credits">
<h2><a class="toc-backref" href="#toc-entry-8">Other credits</a></h2> <h2><a class="toc-backref" href="#toc-entry-8">Other credits</a></h2>
<p>This module is maintained by: <p>This module is maintained by: * Odoo Community Association</p>
* Odoo Community Association</p>
</div> </div>
<div class="section" id="maintainers"> <div class="section" id="maintainers">
<h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2> <h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2>
@ -452,7 +453,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use.</p> promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/16.0/server_environment_ir_config_parameter">OCA/server-env</a> project on GitHub.</p> <p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/17.0/server_environment_ir_config_parameter">OCA/server-env</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p> <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div> </div>
</div> </div>