onedrive.cli module

CLI interfaces for this package.

class onedrive.cli.CopyWorker(client, src, dst, recursive=False, overwrite=False, show_progress=False)

Bases: multiprocessing.context.Process

A worker for copying an item on OneDrive.

Parameters:

client : onedrive.api.OneDriveAPIClient

src, dst : str

Source and destination of the copy operation. Passed to onedrive.api.OneDriveAPIClient.copy.

recursive : bool, optional

Whether to allow recursive copying of a directory. Default is False.

overwrite, show_progress : bool, optional

Passed to onedrive.api.OneDriveAPIClient.copy. Defaults are False.

Attributes

src, dst

(str)

run()

Run the copy operation and monitor status.

The exit code is either 0 or 1, indicating success or failure.

class onedrive.cli.Downloader(client, download_kwargs)

Bases: builtins.object

Downloader that downloads files from OneDrive.

class onedrive.cli.Uploader(client, directory, upload_kwargs)

Bases: builtins.object

Uploader that uploads files to a given OneDrive directory.

Parameters:

client : onedrive.api.OneDriveAPIClient

directory : str

Remote directory to upload to.

upload_kwargs : str

Keyword arguments directly passed to onedrive.api.OneDriveAPIClient.upload.

onedrive.cli.cli_cp()

Alias for cli_mv_or_cp(“cp”, “onedrive-cp”).

onedrive.cli.cli_dirdownload()

Directory download CLI.

onedrive.cli.cli_dirupload()

Directory upload CLI.

onedrive.cli.cli_download()

Download CLI.

onedrive.cli.cli_geturl()

Get URL CLI.

onedrive.cli.cli_ls()

List items CLI.

onedrive.cli.cli_metadata()

Display metadata CLI.

onedrive.cli.cli_mkdir()

Make directory CLI.

onedrive.cli.cli_mv()

Alias for cli_mv_or_cp(“mv”, “onedrive-mv”).

onedrive.cli.cli_mv_or_cp(util, util_name=None)

Mimic the behavior of coreutils mv or cp.

Parameters:

util : {“mv”, “cp”}

util_name : str, optional

Utility name shown in usage and help text. If omitted, will be set to the value of util.

onedrive.cli.cli_rename()

Batch renaming CLI.

onedrive.cli.cli_rm()

Remove CLI.

onedrive.cli.cli_rmdir()

Remove empty directory CLI.

onedrive.cli.cli_upload()

Upload CLI.