ricecooker package

Submodules

ricecooker.classes module

ricecooker.commands module

ricecooker.commands.uploadchannel(path, domain, verbose=False)

guess_content_kind: determines what kind the content is :param path: path to file containing channel data :type path: str :param verbose: indicates whether to print process :type verbose: bool

Returns: (str) link to access newly created channel

ricecooker.config module

ricecooker.config.create_channel_url(domain)

ricecooker.config.file_diff_url(domain)

ricecooker.config.file_upload_url(domain)

ricecooker.config.get_storage_path(filename)

ricecooker.config.open_channel_url(invitation, channel, domain)

ricecooker.exceptions module

exception ricecooker.exceptions.FileNotFoundException(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.InvalidCommandException(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.InvalidFormatException(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.InvalidInputAnswerException(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.InvalidUsageException(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.MissingKeyException(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.UnknownContentKindError(*args, **kwargs)

Bases: Exception

exception ricecooker.exceptions.UnknownQuestionTypeError(*args, **kwargs)

Bases: Exception

ricecooker.exceptions.raise_for_invalid_channel(channel)

ricecooker.managers module

class ricecooker.managers.ChannelManager(channel, domain, verbose=False)

Bases: object

get_file_diff()

process_tree(node, parent=None)

upload_files(file_list)

upload_tree()

class ricecooker.managers.DownloadManager(verbose=False)

Bases: object

all_file_extensions = ['mp4', 'vtt', 'srt', 'mp3', 'wav', 'pdf', 'jpg', 'jpeg', 'png', 'json', 'svg', 'perseus']

download_file(path, hash=None, default_ext='.png', preset=None, force_ext=False)

download_file: downloads files to local storage @param files (list of files to download) @return list of file hashes and extensions

download_files(files)

download_files: downloads files to local storage @param files (list of files to download) @return list of file hashes and extensions

download_graphie(path)

download_file: downloads files to local storage @param files (list of files to download) @return list of file hashes and extensions

download_image(path)

encode_thumbnail(thumbnail)

encode_thumbnail: gets base64 encoding of thumbnail :param thumbnail: file path or url to channel’s thumbnail :type thumbnail: str

Returns: base64 encoding of thumbnail

get_file_mapping()

get_files()

get_hash(request, hash_to_update)

session = <requests.sessions.Session object>

ricecooker.sample_program module

ricecooker.sample_program.construct_channel(args)

ricecooker.sample_program.create_question(raw_question)

Module contents