[IMP] data_encryption: pre-commit auto fixes

data_encryption/README.rst

@@ -17,20 +17,20 @@ Encryption data
     :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--env-lightgray.png?logo=github
-    :target: https://github.com/OCA/server-env/tree/16.0/data_encryption
+    :target: https://github.com/OCA/server-env/tree/17.0/data_encryption
     :alt: OCA/server-env
 .. |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-data_encryption
+    :target: https://translation.odoo-community.org/projects/server-env-17-0/server-env-17-0-data_encryption
     :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-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
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module allows to encrypt and decrypt data. This module is not usable
-by itself, it is a low level module which should work as a base for others.
-An example is the module server_environment_data_encryption
+This module allows to encrypt and decrypt data. This module is not
+usable by itself, it is a low level module which should work as a base
+for others. An example is the module server_environment_data_encryption
 
 .. IMPORTANT::
    This is an alpha version, the data model and design can change at any time without warning.
@@ -47,61 +47,66 @@ Configuration
 
 To configure this module, you need to edit the main configuration file
 of your instance, and add a directive called ``running_env``. Commonly
-used values are 'dev', 'test', 'production'::
+used values are 'dev', 'test', 'production':
 
-  [options]
-  running_env=dev
+::
 
+   [options]
+   running_env=dev
 
-You also need to set the encryption key(s). The main idea is to have different
-encryption keys for your different environment, to avoid the possibility to retrieve
-crucial information from the production environment in a developement environment, for instance.
-So, if your running environment is 'dev'::
+You also need to set the encryption key(s). The main idea is to have
+different encryption keys for your different environment, to avoid the
+possibility to retrieve crucial information from the production
+environment in a developement environment, for instance. So, if your
+running environment is 'dev':
 
-  [options]
-  encryption_key_dev=fyeMIx9XVPBBky5XZeLDxVc9dFKy7Uzas3AoyMarHPA=
+::
 
-In the configuration file of your production environment, you may want to configure
-all your other environments encryption key. This way, from production you can encrypt and decrypt
-data for all environments.
+   [options]
+   encryption_key_dev=fyeMIx9XVPBBky5XZeLDxVc9dFKy7Uzas3AoyMarHPA=
 
-You can generate keys with python -c 'from cryptography.fernet import Fernet; print(Fernet.generate_key())'.
+In the configuration file of your production environment, you may want
+to configure all your other environments encryption key. This way, from
+production you can encrypt and decrypt data for all environments.
+
+You can generate keys with python -c 'from cryptography.fernet import
+Fernet; print(Fernet.generate_key())'.
 
 Known issues / Roadmap
 ======================
 
-For now the encryption is dependent on the environment. It has been designed
-to store the same kind of data with different values depending on the environement
-(dev, preprod, prod...).
-An improvement could be to split this in 2 modules. But the environment stuff
-is not a big constraint.
+For now the encryption is dependent on the environment. It has been
+designed to store the same kind of data with different values depending
+on the environement (dev, preprod, prod...). An improvement could be to
+split this in 2 modules. But the environment stuff is not a big
+constraint.
 
 Bug Tracker
 ===========
 
 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.
 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:%20data_encryption%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:%20data_encryption%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.
 
 Credits
 =======
 
 Authors
-~~~~~~~
+-------
 
 * Akretion
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* Raphaël Reverdy <raphael.reverdy@akretion.com>
-* Florian da Costa <florian.dacosta@akretion.com>
+-  Raphaël Reverdy <raphael.reverdy@akretion.com>
+-  Florian da Costa <florian.dacosta@akretion.com>
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -113,6 +118,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-env <https://github.com/OCA/server-env/tree/16.0/data_encryption>`_ project on GitHub.
+This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/17.0/data_encryption>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

data_encryption/pyproject.toml

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

data_encryption/readme/CONFIGURE.md

@@ -0,0 +1,22 @@
+To configure this module, you need to edit the main configuration file
+of your instance, and add a directive called `running_env`. Commonly
+used values are 'dev', 'test', 'production':
+
+    [options]
+    running_env=dev
+
+You also need to set the encryption key(s). The main idea is to have
+different encryption keys for your different environment, to avoid the
+possibility to retrieve crucial information from the production
+environment in a developement environment, for instance. So, if your
+running environment is 'dev':
+
+    [options]
+    encryption_key_dev=fyeMIx9XVPBBky5XZeLDxVc9dFKy7Uzas3AoyMarHPA=
+
+In the configuration file of your production environment, you may want
+to configure all your other environments encryption key. This way, from
+production you can encrypt and decrypt data for all environments.
+
+You can generate keys with python -c 'from cryptography.fernet import
+Fernet; print(Fernet.generate_key())'.

data_encryption/readme/CONTRIBUTORS.md

@@ -0,0 +1,2 @@
+- Raphaël Reverdy \<<raphael.reverdy@akretion.com>\>
+- Florian da Costa \<<florian.dacosta@akretion.com>\>

data_encryption/readme/DESCRIPTION.md

@@ -0,0 +1,3 @@
+This module allows to encrypt and decrypt data. This module is not
+usable by itself, it is a low level module which should work as a base
+for others. An example is the module server_environment_data_encryption

data_encryption/readme/ROADMAP.md

@@ -0,0 +1,5 @@
+For now the encryption is dependent on the environment. It has been
+designed to store the same kind of data with different values depending
+on the environement (dev, preprod, prod...). An improvement could be to
+split this in 2 modules. But the environment stuff is not a big
+constraint.

data_encryption/static/description/index.html

@@ -1,4 +1,3 @@
-<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
@@ -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,10 +369,10 @@ <h1 class="title">Encryption data</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:2d4447d50c16329e068a3699d69972506a62f5d3235b59046149e6aa76151e0e
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.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/data_encryption"><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-data_encryption"><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>This module allows to encrypt and decrypt data. This module is not usable
-by itself, it is a low level module which should work as a base for others.
-An example is the module server_environment_data_encryption</p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.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/data_encryption"><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-data_encryption"><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>This module allows to encrypt and decrypt data. This module is not
+usable by itself, it is a low level module which should work as a base
+for others. An example is the module server_environment_data_encryption</p>
 <div class="admonition important">
 <p class="first admonition-title">Important</p>
 <p class="last">This is an alpha version, the data model and design can change at any time without warning.
@@ -402,33 +402,35 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 [options]
 running_env=dev
 </pre>
-<p>You also need to set the encryption key(s). The main idea is to have different
-encryption keys for your different environment, to avoid the possibility to retrieve
-crucial information from the production environment in a developement environment, for instance.
-So, if your running environment is ‘dev’:</p>
+<p>You also need to set the encryption key(s). The main idea is to have
+different encryption keys for your different environment, to avoid the
+possibility to retrieve crucial information from the production
+environment in a developement environment, for instance. So, if your
+running environment is ‘dev’:</p>
 <pre class="literal-block">
 [options]
 encryption_key_dev=fyeMIx9XVPBBky5XZeLDxVc9dFKy7Uzas3AoyMarHPA=
 </pre>
-<p>In the configuration file of your production environment, you may want to configure
-all your other environments encryption key. This way, from production you can encrypt and decrypt
-data for all environments.</p>
-<p>You can generate keys with python -c ‘from cryptography.fernet import Fernet; print(Fernet.generate_key())’.</p>
+<p>In the configuration file of your production environment, you may want
+to configure all your other environments encryption key. This way, from
+production you can encrypt and decrypt data for all environments.</p>
+<p>You can generate keys with python -c ‘from cryptography.fernet import
+Fernet; print(Fernet.generate_key())’.</p>
 </div>
 <div class="section" id="known-issues-roadmap">
 <h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>
-<p>For now the encryption is dependent on the environment. It has been designed
-to store the same kind of data with different values depending on the environement
-(dev, preprod, prod…).
-An improvement could be to split this in 2 modules. But the environment stuff
-is not a big constraint.</p>
+<p>For now the encryption is dependent on the environment. It has been
+designed to store the same kind of data with different values depending
+on the environement (dev, preprod, prod…). An improvement could be to
+split this in 2 modules. But the environment stuff is not a big
+constraint.</p>
 </div>
 <div class="section" id="bug-tracker">
 <h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <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.
 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:%20data_encryption%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:%20data_encryption%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>
 </div>
 <div class="section" id="credits">
@@ -449,11 +451,13 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
-<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<a class="reference external image-reference" href="https://odoo-community.org">
+<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
+</a>
 <p>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.</p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-env/tree/16.0/data_encryption">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/data_encryption">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>
 </div>
 </div>

data_encryption/tests/common.py

@@ -29,7 +29,7 @@ def set_new_key_env(self, environment):
         # the key com from the config file and is not in a binary format.
         # So we decode here to avoid having a special behavior because of
         # the tests.
-        config["encryption_key_{}".format(environment)] = crypting_key.decode()
+        config[f"encryption_key_{environment}"] = crypting_key.decode()
 
     def tearDown(self):
         config["running_env"] = self.old_running_env

requirements.txt

@@ -0,0 +1,2 @@
+# generated from manifests external_dependencies
+cryptography