:py:mod:`acquire.acquire.uploaders.plugin`
==========================================

.. py:module:: acquire.acquire.uploaders.plugin


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   acquire.acquire.uploaders.plugin.UploaderPlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   acquire.acquire.uploaders.plugin.upload_files_using_uploader



.. py:class:: UploaderPlugin


   Creates a typing definition to which an UploaderPlugin should adhere.

   .. py:method:: prepare_client(paths: list[pathlib.Path], proxies: Optional[dict[str, str]] = None) -> Any
      :abstractmethod:

      Prepares a client for the upload.


   .. py:method:: upload_file(client: Any, path: pathlib.Path) -> None
      :abstractmethod:

      Uploads a file/path using the ``client``.


   .. py:method:: finish(client: Any) -> None
      :abstractmethod:

      A cleanup step or anything required to finish the upload.



.. py:function:: upload_files_using_uploader(uploader: UploaderPlugin, paths: list[pathlib.Path], proxies: Optional[dict[str, str]] = None) -> None

   Uploads the files in ``paths`` to a destination.

   :param uploader: The plugin used to upload files.
   :param paths: A list of files to upload.
   :param proxies: Proxies used as an intermediate during an upload.