feat:add latex to pdf in FileWriteToolkit #2357

zjrwtx · 2025-05-08T12:30:51Z

Description

close #1908

Checklist

Go over all the following points, and put an x in all the boxes that apply.

I have read the CONTRIBUTION guide (required)
I have linked this PR to an issue using the Development section on the right sidebar or by adding Fixes #issue-number in the PR description (required)
I have checked if any dependencies need to be added or updated in pyproject.toml and uv lock
I have updated the tests accordingly (required for a bug fix or a new feature)
I have updated the documentation if needed:
I have added examples if this is a new feature

If you are unsure about any of these, don't hesitate to ask. We are here to help!

zjrwtx · 2025-05-09T11:32:38Z

JINO-ROHIT · 2025-05-10T14:21:53Z

Thanks! quick question, does this also compile on windows with no errors? used to run into bit of complexities with this library on win

zjrwtx · 2025-05-11T13:30:13Z

Thanks! quick question, does this also compile on windows with no errors? used to run into bit of complexities with this library on win

thanks @JINO-ROHIT ,i havent test on windows,cause im using macos right now. and i have already tested it on macos,it needs the users to install the latex compile before using this,i will test on windows also,please letme know your detailed problems when runing this in windows

JINO-ROHIT · 2025-05-11T15:01:46Z

of course, ill help test this on my windows machine

zjrwtx · 2025-05-12T05:36:51Z

of course, ill help test this on my windows machine

thanks @JINO-ROHIT !

JINO-ROHIT · 2025-05-12T07:28:03Z

hii @zjrwtx , just tested a bit, so for windows installating pylatex alone doesnt work, theres quite a bit of complication 'steps' you had to do to get it working on windows, attaching this manual - https://latextools.readthedocs.io/en/latest/install/#windows

we either mention this somewhere as a caveat.
look for some other alt, thats more easily compilable for all ecosystems.

zjrwtx · 2025-05-14T13:29:28Z

hii @zjrwtx , just tested a bit, so for windows installating pylatex alone doesnt work, theres quite a bit of complication 'steps' you had to do to get it working on windows, attaching this manual - https://latextools.readthedocs.io/en/latest/install/#windows

we either mention this somewhere as a caveat.

look for some other alt, thats more easily compilable for all ecosystems.

thanks for your help @JINO-ROHIT .in macos ,after installing the pylatex,we also need to install some compile latex enginee ,i guess we could let the user know about this. what do you think? cc @Wendong-Fan @MuggleJinx

Wendong-Fan · 2025-05-15T20:43:36Z

hii @zjrwtx , just tested a bit, so for windows installating pylatex alone doesnt work, theres quite a bit of complication 'steps' you had to do to get it working on windows, attaching this manual - https://latextools.readthedocs.io/en/latest/install/#windows

we either mention this somewhere as a caveat.

look for some other alt, thats more easily compilable for all ecosystems.

thanks for your help @JINO-ROHIT .in macos ,after installing the pylatex,we also need to install some compile latex enginee ,i guess we could let the user know about this. what do you think? cc @Wendong-Fan @MuggleJinx

thanks @JINO-ROHIT and @zjrwtx , It would be better if we can make it simpler for the user, would https://github.com/rstudio/tinytex and https://www.gnu.org/software/groff/ be helpful?

MuggleJinx · 2025-05-22T13:10:16Z

camel/toolkits/file_write_toolkit.py

@@ -148,40 +148,73 @@ def _write_docx_file(self, file_path: Path, content: str) -> None:
        document.save(str(file_path))
        logger.debug(f"Wrote DOCX to {file_path} with default formatting")

-    def _write_pdf_file(self, file_path: Path, content: str, **kwargs) -> None:
+    def _write_pdf_file(


To improve, we can add error handling:

Suggested change

def _write_pdf_file(

try:

# PDF generation code

except ImportError as e:

raise RuntimeError(f"Required library not installed: {e}")

except Exception as e:

raise RuntimeError(f"Failed to generate PDF: {e}")

MuggleJinx

The rest looks cool to me.

lightaime · 2025-05-23T03:07:08Z

examples/toolkits/file_write_toolkit.py

+print(
+    "Example 7: Please give me a  pdf file with formulas of advanced mathematics"
+)


Suggested change

print(

"Example 7: Please give me a pdf file with formulas of advanced mathematics"

)

print(f"Example 7: {latex_pdf_query})

lightaime · 2025-05-23T03:09:47Z

examples/toolkits/file_write_toolkit.py

+
+camel_agent.reset()
+response = camel_agent.step(pdf_query)
+print("Example 7: what is multiagent?please export  them as pdf file")


Suggested change

print("Example 7: what is multiagent?please export them as pdf file")

print(f"Example 8: {pdf_query}")

lightaime · 2025-05-23T03:09:54Z

examples/toolkits/file_write_toolkit.py

+
+
+# Example 8: what is multiagent?please export  them as pdf file
+pdf_query = """what is multiagent?please export them as pdf file"""


Suggested change

pdf_query = """what is multiagent?please export them as pdf file"""

pdf_query = """what is multiagent? Please export them as pdf file"""

lightaime · 2025-05-23T03:11:08Z

camel/toolkits/file_write_toolkit.py

@@ -148,40 +148,73 @@ def _write_docx_file(self, file_path: Path, content: str) -> None:
        document.save(str(file_path))
        logger.debug(f"Wrote DOCX to {file_path} with default formatting")

-    def _write_pdf_file(self, file_path: Path, content: str, **kwargs) -> None:
+    def _write_pdf_file(


Add dependencies_required decorator

lightaime

Thanks @zjrwtx! It would be cool to record a demo on this!

zjrwtx · 2025-05-23T10:27:46Z

Thanks @zjrwtx! It would be cool to record a demo on this!

thanks @lightaime ,i will do that.

zjrwtx · 2025-05-23T10:28:11Z

The rest looks cool to me.

thanks @MuggleJinx

Wendong-Fan

thanks @zjrwtx , left some comments below and added one more PR: #2485, feel free to review and let me know if there's anything need further discussion

Wendong-Fan · 2025-05-25T20:05:05Z

camel/toolkits/file_write_toolkit.py

        """
-        from fpdf import FPDF
+        if use_latex:
+            from pylatex import (  # type: ignore[import-not-found, import-untyped]


why skip mypy test here, should we add pylatex to pyproject.toml?

Wendong-Fan · 2025-05-25T20:08:54Z

camel/toolkits/file_write_toolkit.py

+            use_latex (bool): Whether to use LaTeX for rendering .
+                (requires LaTeX toolchain)
+                If False, uses FPDF for simpler PDF generation.
+                (default: False)

        Raises:
-            RuntimeError: If the 'fpdf' library is not installed.
+            RuntimeError: If the 'pylatex' library is not installed
+            when use_latex=True.
+            RuntimeError: If the 'fpdf' library is not installed
+            when use_latex=False.
        """


docstring format

use_latex (bool): Whether to use LaTeX for rendering. (requires LaTeX toolchain). If False, uses FPDF for simpler PDF generation. (default: :obj: `False`) Raises: RuntimeError: If the 'pylatex' or 'fpdf' library is not installed when use_latex=True. """

Wendong-Fan · 2025-05-25T20:18:32Z

examples/toolkits/file_write_toolkit.py

+
+# Example 7: Please give me a  pdf file with formulas of advanced mathematics
+latex_pdf_query = (
+    """Please give me a  pdf file with formulas of advanced mathematics."""


Suggested change

"""Please give me a pdf file with formulas of advanced mathematics."""

"""Please give me a pdf file with formulas of advanced mathematics."""

Wendong-Fan · 2025-05-25T20:26:13Z

camel/toolkits/file_write_toolkit.py

-                pdf.multi_cell(0, line_height, para)
-            else:
-                pdf.ln(line_height)  # Add empty line
+            logger.debug(f"Wrote PDF (with  LaTeX) to {file_path}")


Suggested change

logger.debug(f"Wrote PDF (with LaTeX) to {file_path}")

logger.debug(f"Wrote PDF (with LaTeX) to {file_path}")

Wendong-Fan · 2025-05-25T20:32:35Z

camel/toolkits/file_write_toolkit.py

+                    if '$' in line:
+                        doc.append(Math(data=line.strip('$')))


here seems could be buggy if a line contains $ but is not a simple math expression enclosed by $, like"Price: $10")

add latex to pdf

3c0bb30

zjrwtx marked this pull request as draft May 8, 2025 12:32

zjrwtx added 3 commits May 8, 2025 20:32

Merge branch 'master' into filewrite

193a3b9

Merge branch 'master' into filewrite

a11120d

update

4f1c30e

zjrwtx force-pushed the filewrite branch from 5621c21 to 4f1c30e Compare May 9, 2025 10:56

update

e181182

zjrwtx self-assigned this May 9, 2025

zjrwtx marked this pull request as ready for review May 9, 2025 11:24

zjrwtx requested a review from Wendong-Fan May 9, 2025 11:26

zjrwtx added 2 commits May 9, 2025 19:50

fix conflict and mini content change

79ca84c

fix conflict

30185bd

zjrwtx requested a review from MuggleJinx May 9, 2025 14:11

JINO-ROHIT added 2 commits May 10, 2025 19:51

Merge branch 'master' into filewrite

e5e6f6c

Merge branch 'master' into filewrite

8605146

Merge branch 'master' into filewrite

fd5f81f

Merge branch 'master' into filewrite

4ed5435

Wendong-Fan added the Waiting for Update PR has been reviewed, need to be updated based on review comment label May 18, 2025

Wendong-Fan added this to Project Camel May 18, 2025

Wendong-Fan added this to the Sprint 29 milestone May 18, 2025

MuggleJinx reviewed May 22, 2025

View reviewed changes

MuggleJinx approved these changes May 22, 2025

View reviewed changes

lightaime reviewed May 23, 2025

View reviewed changes

zjrwtx added 6 commits May 23, 2025 18:28

fix conflict

d9db79e

fix conflict

b6ede6a

solve comment problems

656c450

fix pre-commit

a01e897

fix pre-commit

46d5b44

fix

0169ee3

zjrwtx removed the Waiting for Update PR has been reviewed, need to be updated based on review comment label May 25, 2025

zjrwtx and others added 2 commits May 25, 2025 21:26

Merge branch 'master' into filewrite

fb7299f

Merge branch 'master' into filewrite

3048fbd

Wendong-Fan reviewed May 25, 2025

View reviewed changes

enhance: add latex to pdf in FileWriteToolkit PR2357 (#2485)

78fca91

Wendong-Fan merged commit cb9fc9f into master May 25, 2025
8 checks passed

Wendong-Fan deleted the filewrite branch May 25, 2025 20:41

-    def _write_pdf_file(
+ try:
+       # PDF generation code
+   except ImportError as e:
+       raise RuntimeError(f"Required library not installed: {e}")
+   except Exception as e:
+       raise RuntimeError(f"Failed to generate PDF: {e}")

	print("Example 7: what is multiagent?please export them as pdf file")
	print(f"Example 8: {pdf_query}")



		# Example 8: what is multiagent?please export them as pdf file
		pdf_query = """what is multiagent?please export them as pdf file"""

	pdf_query = """what is multiagent?please export them as pdf file"""
	pdf_query = """what is multiagent? Please export them as pdf file"""

	"""Please give me a pdf file with formulas of advanced mathematics."""
	"""Please give me a pdf file with formulas of advanced mathematics."""

	logger.debug(f"Wrote PDF (with LaTeX) to {file_path}")
	logger.debug(f"Wrote PDF (with LaTeX) to {file_path}")

feat:add latex to pdf in FileWriteToolkit #2357

feat:add latex to pdf in FileWriteToolkit #2357

Uh oh!

Conversation

zjrwtx commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

zjrwtx commented May 9, 2025

Uh oh!

JINO-ROHIT commented May 10, 2025

Uh oh!

zjrwtx commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JINO-ROHIT commented May 11, 2025

Uh oh!

zjrwtx commented May 12, 2025

Uh oh!

JINO-ROHIT commented May 12, 2025

Uh oh!

zjrwtx commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wendong-Fan commented May 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MuggleJinx left a comment

Choose a reason for hiding this comment

Uh oh!

lightaime May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lightaime left a comment

Choose a reason for hiding this comment

Uh oh!

zjrwtx commented May 23, 2025

Uh oh!

zjrwtx commented May 23, 2025

Uh oh!

Wendong-Fan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zjrwtx commented May 8, 2025 •

edited

Loading

zjrwtx commented May 11, 2025 •

edited

Loading

zjrwtx commented May 14, 2025 •

edited

Loading

lightaime May 23, 2025 •

edited

Loading

Wendong-Fan left a comment •

edited

Loading