.. _f-encryptedbackup:

module ``filehelper.encrypted_backup``
======================================





.. inheritance-diagram:: pyquickhelper.filehelper.encrypted_backup


Short summary
+++++++++++++

module ``pyquickhelper.filehelper.encrypted_backup``

Keeps an encrypted of personal data


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| class                                                                                          | truncated documentation                                                                                                 |
+================================================================================================+=========================================================================================================================+
| :class:`EncryptedBackup <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup>`           | This class aims at keeping an encrypted and compressed backup of files. Every file is compressed and then encrypted ... |
+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :class:`EncryptedBackupError <pyquickhelper.filehelper.encrypted_backup.EncryptedBackupError>` | raised by :class:`EncryptedBackup`                                                                                      |
+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+-------------------------------------------------------------------------------------+-------------------------+
| property                                                                            | truncated documentation |
+=====================================================================================+=========================+
| :meth:`Mapping <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.Mapping>` | returns the mapping     |
+-------------------------------------------------------------------------------------+-------------------------+






Methods
+++++++

+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| method                                                                                                            | truncated documentation                                                |
+===================================================================================================================+========================================================================+
| :py:meth:`__init__ <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.__init__>`                          | constructor                                                            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`compress <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.compress>`                             | compress data                                                          |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`decompress <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.decompress>`                         | decompress data                                                        |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`enumerate_read_encrypt <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.enumerate_read_encrypt>` | enumerate pieces of files as bytes                                     |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`iter_eligible_files <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.iter_eligible_files>`       | iterates on eligible file for transfering (if they have been modified) |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`load_mapping <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.load_mapping>`                     | retrieves existing mapping                                             |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`retrieve <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.retrieve>`                             | retrieve a backuped file                                               |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`retrieve_all <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.retrieve_all>`                     | retrieve all backuped files                                            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`start_transfering <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.start_transfering>`           | starts transfering files to the remote website                         |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`transfer <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.transfer>`                             | transfer data                                                          |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`transfer_mapping <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.transfer_mapping>`             | transfer the mapping                                                   |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`update_mapping <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.update_mapping>`                 | update the status of a file                                            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+
| :meth:`update_status <pyquickhelper.filehelper.encrypted_backup.EncryptedBackup.update_status>`                   | update the status of a file                                            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.filehelper.encrypted_backup
    :members:
    :special-members: __init__
    :show-inheritance: