API reference#

Client#

DownloaderClient(local_data_dir[, token, ...])

Downloader Client class.

UploaderClient(local_data_dir[, token, ...])

Uploader Client class.

ClientABC#

_base.CommonDryRunClient([token, base_url, ...])

This class is generated to run dry-run operation.

_base.CommonNoLocalVolumeClient([token, ...])

This class is generated to run without local volume.

_base.CommonClient(local_data_dir[, token, ...])

Common class among normal clients.

_base.DownloaderClientABC(local_data_dir[, ...])

Abstract class for Downloader Clients.

_base.UploaderClientABC(local_data_dir[, ...])

Abstract class for Uploader Clients.

functions#

functions.common

functions.common.get_channels_list(client)

get channel list.

functions.common.get_file_volumes(client[, ...])

Calculate the total file volumes (bytes)

functions.common.get_replies(client, ...)

get replies to the specific message.

functions.common.test_connection(client)

test connections to slack.

functions.common.test_downloader(client)

test connections to slack as downloader.

functions.common.test_uploader(client)

test connections to slack as uploader.

functions.download

functions.download.download_bookmark(client, ...)

download and save a series of bookmarks on a channel.

functions.download.download_channel_history(...)

download and save a series of channel histories on a channel.

functions.download.download_channels_list(client)

download and save channel list.

functions.download.download_emoji(client)

download and save a moji list and emoji files.

functions.download.download_file(client, ...)

download and save a specified file.

functions.download.download_members_list(client)

download and save a member list.

functions.upload

functions.upload.check_channel_exists(...)

check if a channel already exists or not

functions.upload.check_insert_finished(...)

check if the uploading for a channel already finished or not.

functions.upload.check_upload_conflict(client)

check upload conflict in terms of channel name.

functions.upload.create_all_channels(client)

create all channels or specified channels.

functions.upload.data_insert(client, ...[, ...])

upload messages, files, reactions, and pins.

functions.upload.insert_bookmarks(client, ...)

insert a series of bookmarks to a channel.

functions.upload.upload_file(client, ...[, ...])

upload a file.

CLI#

cli.bookmark

cli.download

cli.emoji

cli.file_volume

cli.main

cli.token_test

cli.upload

Others#

__version__

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

run.run(local_data_dir[, downloader_token, ...])

See run section in CLI

interactive.interactive()

See interactive section in CLI