ADD documentation field password

DjangoCrypto · Jun 1, 2021 · 57039f8 · 57039f8
1 parent 10f3074
commit 57039f8
Show file tree

Hide file tree

Showing 12 changed files with 17 additions and 0 deletions.
diff --git a/.github/workflows/Release.yml b/.github/workflows/Release.yml
diff --git a/README.rst b/README.rst
diff --git a/django_crypto_extensions/django_fields.py b/django_crypto_extensions/django_fields.py
diff --git a/django_crypto_extensions/tests/__init__.py b/django_crypto_extensions/tests/__init__.py
diff --git a/django_crypto_extensions/tests/apps.py b/django_crypto_extensions/tests/apps.py
diff --git a/django_crypto_extensions/tests/models.py b/django_crypto_extensions/tests/models.py
diff --git a/django_crypto_extensions/tests/settings.py b/django_crypto_extensions/tests/settings.py
diff --git a/docs/3_usage.rst b/docs/3_usage.rst
@@ -36,6 +36,7 @@ Example of how to use to create custom CryptoTextField::
 + each CryptoField has 2 kwargs ``salt_settings_env`` and ``password``.
 + salt_settings_env - name of variable stored in ``settings.py`` file, which will be used as cryptographic salt. ``default: salt_settings_env = 'SECRET_KEY'`` if settings not set or no SECRET_KEY in setting ``default: salt = "Salt123!!!"``
 + password - password to be used in encryption process of given field (together with salt set globally) ``default = 'password'``
++ password_field - name of field from which to import password. It i most recommended to ue @property instead of actual field
 
 **Example**::
 
@@ -50,6 +51,22 @@ Example of how to use to create custom CryptoTextField::
         value = CryptoEmailField(salt_settings_env='NEW_SECRET_KEY', password='new_password')
 
 
+**Example2**::
+
+    # models.py
+
+    from django.db import models
+
+    from django_crypto_extensions.django_fields import CryptoEmailField
+
+    class CryptoTextModelPasswordFromField(models.Model):
+
+        @property
+        def password(self):
+            return "password_field_to_be_used_as_key"
+
+        value = CryptoTextField(password_field="password")
+
 CryptoBinaryField and CryptoCharField
 ---------------------------------------
 

diff --git a/docs/4_contribution.rst b/docs/4_contribution.rst
diff --git a/pytest.ini b/pytest.ini
diff --git a/setup.cfg b/setup.cfg
diff --git a/tests/test_django_fields.py b/tests/test_django_fields.py