Camel.toolkits.pptx toolkit

​

PPTXToolkit

class PPTXToolkit(BaseToolkit):

​

init

def __init__(
    self,
    working_directory: Optional[str] = None,
    timeout: Optional[float] = None
):

• working_directory (str, optional): The default directory for output files. If not provided, it will be determined by the CAMEL_WORKDIR environment variable (if set). If the environment variable is not set, it defaults to camel_working_dir.
• timeout (Optional[float]): The timeout for the toolkit. (default: :obj:None)

​

_resolve_filepath

def _resolve_filepath(self, file_path: str):

• file_path (str): The file path to resolve.

​

_sanitize_filename

def _sanitize_filename(self, filename: str):

• filename (str): The filename to sanitize.

​

_format_text

def _format_text(
    self,
    frame_paragraph,
    text: str,
    set_color_to_white = False
):

• frame_paragraph: The paragraph to format.
• text (str): The text to format.
• set_color_to_white (bool): Whether to set the color to white. (default: :obj:False)

​

_add_bulleted_items

def _add_bulleted_items(
    self,
    text_frame: 'TextFrame',
    flat_items_list: List[Tuple[str, int]],
    set_color_to_white: bool = False
):

• text_frame (TextFrame): The text frame where text is to be displayed.
• flat_items_list (List[Tuple[str, int]]): The list of items to be displayed.
• set_color_to_white (bool): Whether to set the font color to white. (default: :obj:False)

​

_get_flat_list_of_contents

def _get_flat_list_of_contents(self, items: List[Union[str, List[Any]]], level: int):

• items (List[Union[str, List[Any]]]): A bullet point (string or list).
• level (int): The current level of hierarchy.

​

_get_slide_width_height_inches

def _get_slide_width_height_inches(self, presentation: 'presentation.Presentation'):

• presentation (presentation.Presentation): The presentation object.

​

_write_pptx_file

def _write_pptx_file(
    self,
    file_path: Path,
    content: List[Dict[str, Any]],
    template: Optional[str] = None
):

• file_path (Path): The target file path.
• content (List[Dict[str, Any]]): The content to write to the PPTX file. Must be a list of dictionaries where: - First element: Title slide with keys ‘title’ and ‘subtitle’ - Subsequent elements: Content slides with keys ‘title’, ‘text’
• template (Optional[str]): The name of the template to use. If not provided, the default template will be used. (default: :obj: None)

​

create_presentation

def create_presentation(
    self,
    content: str,
    filename: str,
    template: Optional[str] = None
):

• content (str): The content to write to the PPTX file as a JSON string. Must represent a list of dictionaries with the following structure: - First dict: title slide {"title": str, "subtitle": str} - Other dicts: content slides, which can be one of: * Bullet/step slides: {"heading": str, "bullet_points": list of str or nested lists, "img_keywords": str (optional)} - If any bullet point starts with ’>> ’, it will be rendered as a step-by-step process. - “img_keywords” can be a URL or search keywords for an image (optional). * Table slides: {"heading": str, "table": {"headers": list of str, "rows": list of list of str}}
• filename (str): The name or path of the file. If a relative path is supplied, it is resolved to self.working_directory.
• template (Optional[str]): The path to the template PPTX file. Initializes a presentation from a given template file Or PPTX file. (default: :obj:None)

​

_handle_default_display

def _handle_default_display(
    self,
    presentation: 'presentation.Presentation',
    slide_json: Dict[str, Any]
):

• presentation (presentation.Presentation): The presentation object.
• slide_json (Dict[str, Any]): The content of the slide as JSON data.

​

_handle_display_image__in_foreground

def _handle_display_image__in_foreground(
    self,
    presentation: 'presentation.Presentation',
    slide_json: Dict[str, Any]
):

• presentation (presentation.Presentation): The presentation object.
• slide_json (Dict[str, Any]): The content of the slide as JSON data.

​

_handle_table

def _handle_table(
    self,
    presentation: 'presentation.Presentation',
    slide_json: Dict[str, Any]
):

• presentation (presentation.Presentation): The presentation object.
• slide_json (Dict[str, Any]): The content of the slide as JSON data.

​

_handle_step_by_step_process

def _handle_step_by_step_process(
    self,
    presentation: 'presentation.Presentation',
    slide_json: Dict[str, Any],
    slide_width_inch: float,
    slide_height_inch: float
):

• presentation (presentation.Presentation): The presentation object.
• slide_json (Dict[str, Any]): The content of the slide as JSON data.
• slide_width_inch (float): The width of the slide in inches.
• slide_height_inch (float): The height of the slide in inches.

​

_remove_slide_number_from_heading

def _remove_slide_number_from_heading(self, header: str):

• header (str): The header of a slide.

​

_get_slide_placeholders

def _get_slide_placeholders(self, slide: 'Slide'):

• slide (Slide): The slide.

​

get_tools

def get_tools(self):