acquire.acquire.uploaders.plugin

Module Contents

Classes

UploaderPlugin

Creates a typing definition to which an UploaderPlugin should adhere.

Functions

upload_files_using_uploader

Uploads the files in paths to a destination.
class acquire.acquire.uploaders.plugin.UploaderPlugin

Creates a typing definition to which an UploaderPlugin should adhere.

abstract prepare_client(paths: list[pathlib.Path], proxies: dict[str, str] | None = None) → Any

Prepares a client for the upload.

abstract upload_file(client: Any, path: pathlib.Path) → None

Uploads a file/path using the client.

abstract finish(client: Any) → None

A cleanup step or anything required to finish the upload.

acquire.acquire.uploaders.plugin.upload_files_using_uploader(uploader: UploaderPlugin, paths: list[str | pathlib.Path], proxies: dict[str, str] | None = None) → None

Uploads the files in paths to a destination.

Parameters:

  • uploader – The plugin used to upload files.

  • paths – A list of files to upload.

  • proxies – Proxies used as an intermediate during an upload.