.. _f-transferapiftp:

module ``filehelper.transfer_api_ftp``
======================================





.. inheritance-diagram:: pyquickhelper.filehelper.transfer_api_ftp


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

module ``pyquickhelper.filehelper.transfer_api_ftp``

API to move files using FTP


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
| class                                                                              | truncated documentation                                                      |
+====================================================================================+==============================================================================+
| :class:`TransferAPIFtp <pyquickhelper.filehelper.transfer_api_ftp.TransferAPIFtp>` | Defines an API to transfer files over a remote location through :epkg:`FTP`. |
+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+










Methods
+++++++

+-----------------------------------------------------------------------------------------+----------------------------------------------------------+
| method                                                                                  | truncated documentation                                  |
+=========================================================================================+==========================================================+
| :py:meth:`__init__ <pyquickhelper.filehelper.transfer_api_ftp.TransferAPIFtp.__init__>` |                                                          |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------+
| :meth:`close <pyquickhelper.filehelper.transfer_api_ftp.TransferAPIFtp.close>`          | close the connection                                     |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------+
| :meth:`connect <pyquickhelper.filehelper.transfer_api_ftp.TransferAPIFtp.connect>`      | connect                                                  |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------+
| :meth:`retrieve <pyquickhelper.filehelper.transfer_api_ftp.TransferAPIFtp.retrieve>`    | retrieve data from path                                  |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------+
| :meth:`transfer <pyquickhelper.filehelper.transfer_api_ftp.TransferAPIFtp.transfer>`    | It assumes a data holds in memory, tansfer data to path. |
+-----------------------------------------------------------------------------------------+----------------------------------------------------------+


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

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