.. _f-transferapifile:

module ``filehelper.transfer_api_file``
=======================================





.. inheritance-diagram:: pyquickhelper.filehelper.transfer_api_file


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

module ``pyquickhelper.filehelper.transfer_api_file``

API to move files using FTP


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------------+---------------------------------------------------------+
| class                                                                                 | truncated documentation                                 |
+=======================================================================================+=========================================================+
| :class:`TransferAPIFile <pyquickhelper.filehelper.transfer_api_file.TransferAPIFile>` | Defines an API to transfer files over another location. |
+---------------------------------------------------------------------------------------+---------------------------------------------------------+










Methods
+++++++

+-------------------------------------------------------------------------------------------+----------------------------------------------------------+
| method                                                                                    | truncated documentation                                  |
+===========================================================================================+==========================================================+
| :py:meth:`__init__ <pyquickhelper.filehelper.transfer_api_file.TransferAPIFile.__init__>` |                                                          |
+-------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :meth:`retrieve <pyquickhelper.filehelper.transfer_api_file.TransferAPIFile.retrieve>`    | Retrieves data from path.                                |
+-------------------------------------------------------------------------------------------+----------------------------------------------------------+
| :meth:`transfer <pyquickhelper.filehelper.transfer_api_file.TransferAPIFile.transfer>`    | It assumes a data holds in memory, tansfer data to path. |
+-------------------------------------------------------------------------------------------+----------------------------------------------------------+


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

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