waldiez 0.1.11__py3-none-any.whl → 0.1.12__py3-none-any.whl

waldiez/__main__.py

@@ -1,6 +1,6 @@
 """Waldiez entrypoint when called as a module."""
 
-from .cli import main
+from .cli import app
 
 if __name__ == "__main__":
-    main()
+    app()

waldiez/_version.py

@@ -1,3 +1,3 @@
 """Version information for Waldiez."""
 
-__version__ = "0.1.11"
+__version__ = "0.1.12"

waldiez/cli.py

@@ -1,12 +1,15 @@
 """Command line interface to convert or run a waldiez file."""
 
-import argparse
+# pylint: disable=missing-function-docstring,missing-param-doc,missing-raises-doc
 import json
 import logging
 import os
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Dict, Optional
+from typing import TYPE_CHECKING, Optional
+
+import typer
+from typing_extensions import Annotated
 
 from . import Waldiez, __version__
 from .exporter import WaldiezExporter
@@ -16,121 +19,169 @@ if TYPE_CHECKING:
     from autogen import ChatResult  # type: ignore[import-untyped]
 
 
-def get_parser() -> argparse.ArgumentParser:
-    """Get the argument parser for the Waldiez package.
-
-    Returns
-    -------
-    argparse.ArgumentParser
-        The argument parser.
-    """
-    parser = argparse.ArgumentParser(
-        description="Run or export a Waldiez flow.",
-        prog="waldiez",
-    )
-    parser.add_argument(
-        "file",
-        type=str,
-        help="Path to the Waldiez flow (*.waldiez) file.",
-    )
-    parser.add_argument(
-        "-e",
-        "--export",
-        action="store_true",
-        help=(
-            "Export the Waldiez flow to a Python script or a jupyter notebook."
+app = typer.Typer(
+    name="waldiez",
+    help="Handle Waldiez flows.",
+    context_settings={
+        "help_option_names": ["-h", "--help"],
+        "allow_extra_args": True,
+    },
+    add_completion=False,
+    no_args_is_help=True,
+    invoke_without_command=True,
+    add_help_option=True,
+    pretty_exceptions_enable=False,
+    epilog=("Use `waldiez [COMMAND] --help` for command-specific help. "),
+)
+
+
+@app.callback()
+def show_version(
+    version: bool = typer.Option(
+        False,
+        "--version",
+        "-v",
+        help="Show the version of the Waldiez package.",
+    ),
+) -> None:
+    """Show the version of the Waldiez package and exit."""
+    if version:
+        typer.echo(f"waldiez version: {__version__}")
+        raise typer.Exit()
+
+
+@app.command()
+def run(
+    file: Annotated[
+        Path,
+        typer.Option(
+            ...,
+            help="Path to the Waldiez flow (*.waldiez) file.",
+            exists=True,
+            file_okay=True,
+            dir_okay=False,
+            readable=True,
+            resolve_path=True,
         ),
-    )
-    parser.add_argument(
-        "-o",
-        "--output",
-        type=str,
+    ],
+    output: Optional[Path] = typer.Option(
+        None,
         help=(
-            "Path to the output file. "
-            "If exporting, the file extension determines the output format. "
-            "If running, the output's directory will contain "
+            "Path to the output (.py) file. "
+            "The output's directory will contain "
             "the generated flow (.py) and any additional generated files."
         ),
-    )
-    parser.add_argument(
-        "-f",
-        "--force",
-        action="store_true",
-        help=("Override the output file if it already exists. "),
-    )
-    parser.add_argument(
-        "-v",
-        "--version",
-        action="version",
-        version=f"waldiez version: {__version__}",
-    )
-    return parser
-
-
-def _log_result(result: "ChatResult") -> None:
-    """Log the result of the Waldiez flow."""
-    logger = logging.getLogger("waldiez::cli")
-    logger.info("Chat History:\n")
-    logger.info(result.chat_history)
-    logger.info("Summary:\n")
-    logger.info(result.summary)
-    logger.info("Cost:\n")
-    logger.info(result.cost)
-
-
-def _run(data: Dict[str, Any], output_path: Optional[str]) -> None:
-    """Run the Waldiez flow."""
+        dir_okay=False,
+        resolve_path=True,
+    ),
+    force: bool = typer.Option(
+        False,
+        help="Override the output file if it already exists.",
+    ),
+) -> None:
+    """Run a Waldiez flow."""
+    output_path = _get_output_path(output, force)
+    with file.open("r", encoding="utf-8") as _file:
+        try:
+            data = json.load(_file)
+        except json.decoder.JSONDecodeError as error:
+            typer.echo("Invalid .waldiez file. Not a valid json?")
+            raise typer.Exit(code=1) from error
     waldiez = Waldiez.from_dict(data)
     runner = WaldiezRunner(waldiez)
     results = runner.run(stream=None, output_path=output_path)
+    logger = _get_logger()
     if isinstance(results, list):
+        logger.info("Results:")
         for result in results:
-            _log_result(result)
+            _log_result(result, logger)
             sep = "-" * 80
             print(f"\n{sep}\n")
     else:
-        _log_result(results)
-
-
-def main() -> None:
-    """Parse the command line arguments and run the Waldiez flow."""
-    parser = get_parser()
-    if len(sys.argv) == 1:
-        parser.print_help()
-        sys.exit(0)
-    args = parser.parse_args()
-    logger = _get_logger()
-    waldiez_file: str = args.file
-    if not os.path.exists(waldiez_file):
-        logger.error("File not found: %s", waldiez_file)
-        sys.exit(1)
-    if not waldiez_file.endswith((".json", ".waldiez")):
-        logger.error("Only .json or .waldiez files are supported.")
-        sys.exit(1)
-    with open(waldiez_file, "r", encoding="utf-8") as file:
+        _log_result(results, logger)
+
+
+@app.command()
+def convert(
+    file: Annotated[
+        Path,
+        typer.Option(
+            ...,
+            help="Path to the Waldiez flow (*.waldiez) file.",
+            exists=True,
+            file_okay=True,
+            dir_okay=False,
+            readable=True,
+            resolve_path=True,
+        ),
+    ],
+    output: Annotated[
+        Path,
+        typer.Option(
+            ...,
+            help=(
+                "Path to the output file. "
+                "The file extension determines the output format: "
+                "`.py` for Python script, `.ipynb` for Jupyter notebook."
+            ),
+            file_okay=True,
+            dir_okay=False,
+            resolve_path=True,
+        ),
+    ],
+    force: bool = typer.Option(
+        False,
+        help="Override the output file if it already exists.",
+    ),
+) -> None:
+    """Convert a Waldiez flow to a Python script or a Jupyter notebook."""
+    _get_output_path(output, force)
+    with file.open("r", encoding="utf-8") as _file:
         try:
-            data = json.load(file)
-        except json.decoder.JSONDecodeError:
-            logger.error("Invalid .waldiez file: %s. Not a valid json?", file)
-            return
-    if args.export is True:
-        if args.output is None:
-            logger.error("Please provide an output file.")
-            sys.exit(1)
-        if not args.output.endswith((".py", ".ipynb", ".json", ".waldiez")):
-            logger.error(
-                "Only Python scripts, Jupyter notebooks "
-                "and JSON/Waldiez files are supported."
-            )
-            sys.exit(1)
-        output_file = Path(args.output).resolve()
-        waldiez = Waldiez.from_dict(data)
-        exporter = WaldiezExporter(waldiez)
-        exporter.export(output_file, force=args.force)
-        generated = str(output_file).replace(os.getcwd(), ".")
-        logger.info("Generated: %s", generated)
-    else:
-        _run(data, args.output)
+            data = json.load(_file)
+        except json.decoder.JSONDecodeError as error:
+            typer.echo("Invalid .waldiez file. Not a valid json?")
+            raise typer.Exit(code=1) from error
+    waldiez = Waldiez.from_dict(data)
+    exporter = WaldiezExporter(waldiez)
+    exporter.export(output, force=force)
+    generated = str(output).replace(os.getcwd(), ".")
+    typer.echo(f"Generated: {generated}")
+
+
+@app.command()
+def check(
+    file: Annotated[
+        Path,
+        typer.Option(
+            ...,
+            help="Path to the Waldiez flow (*.waldiez) file.",
+            exists=True,
+            file_okay=True,
+            dir_okay=False,
+            readable=True,
+            resolve_path=True,
+        ),
+    ],
+) -> None:
+    """Validate a Waldiez flow."""
+    with file.open("r", encoding="utf-8") as _file:
+        data = json.load(_file)
+    Waldiez.from_dict(data)
+    typer.echo("Waldiez flow is valid.")
+
+
+def _get_output_path(output: Optional[Path], force: bool) -> Optional[Path]:
+    if output is not None:
+        output = Path(output).resolve()
+    if output is not None and not output.parent.exists():
+        output.parent.mkdir(parents=True)
+    if output is not None and output.exists():
+        if force is False:
+            typer.echo("Output file already exists.")
+            raise typer.Exit(code=1)
+        output.unlink()
+    return output
 
 
 def _get_logger(level: int = logging.INFO) -> logging.Logger:
@@ -162,5 +213,16 @@ def _get_logger(level: int = logging.INFO) -> logging.Logger:
     return logger
 
 
+def _log_result(result: "ChatResult", logger: logging.Logger) -> None:
+    """Log the result of the Waldiez flow."""
+    logger.info("Chat History:\n")
+    logger.info(result.chat_history)
+    logger.info("Summary:\n")
+    logger.info(result.summary)
+    logger.info("Cost:\n")
+    logger.info(result.cost)
+
+
 if __name__ == "__main__":
-    main()
+    _get_logger()
+    app()

waldiez/runner.py

@@ -169,8 +169,12 @@ class WaldiezRunner:
             print_function(
                 f"Installing requirements: {', '.join(extra_requirements)}"
             )
+            pip_install = [sys.executable, "-m", "pip", "install"]
+            if not in_virtualenv():
+                pip_install.append("--user")
+            pip_install.extend(extra_requirements)
             with subprocess.Popen(
-                [sys.executable, "-m", "pip", "install", *extra_requirements],
+                pip_install,
                 stdout=subprocess.PIPE,
                 stderr=subprocess.PIPE,
             ) as proc:
@@ -341,3 +345,16 @@ class WaldiezRunner:
             self._running = False
             self._stream.reset(token)
             del token
+
+
+def in_virtualenv() -> bool:
+    """Check if we are inside a virtualenv.
+
+    Returns
+    -------
+    bool
+        True if inside a virtualenv, False otherwise.
+    """
+    return hasattr(sys, "real_prefix") or (
+        hasattr(sys, "base_prefix") and sys.base_prefix != sys.prefix
+    )

{waldiez-0.1.11.dist-info → waldiez-0.1.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: waldiez
-Version: 0.1.11
+Version: 0.1.12
 Summary: waldiez
 Project-URL: homepage, https://waldiez.github.io/waldiez/
 Project-URL: repository, https://github.com/waldiez/waldiez.git
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: <3.13,>=3.10
 Requires-Dist: ag2==0.4.1
 Requires-Dist: jupytext
+Requires-Dist: typer<0.13,>=0.9
 Provides-Extra: ag2-extras
 Requires-Dist: ag2[anthropic]==0.4.1; extra == 'ag2-extras'
 Requires-Dist: ag2[bedrock]==0.4.1; extra == 'ag2-extras'
@@ -46,7 +47,7 @@ Requires-Dist: isort==5.13.2; extra == 'dev'
 Requires-Dist: mypy==1.13.0; extra == 'dev'
 Requires-Dist: pre-commit==4.0.1; extra == 'dev'
 Requires-Dist: pydocstyle==6.3.0; extra == 'dev'
-Requires-Dist: pylint==3.3.1; extra == 'dev'
+Requires-Dist: pylint==3.3.2; extra == 'dev'
 Requires-Dist: python-dotenv==1.0.1; extra == 'dev'
 Requires-Dist: ruff==0.8.1; extra == 'dev'
 Requires-Dist: types-pyyaml==6.0.12.20240917; extra == 'dev'
@@ -56,7 +57,7 @@ Requires-Dist: mdx-include==1.4.2; extra == 'docs'
 Requires-Dist: mdx-truly-sane-lists==1.3; extra == 'docs'
 Requires-Dist: mkdocs-jupyter==0.25.1; extra == 'docs'
 Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == 'docs'
-Requires-Dist: mkdocs-material==9.5.46; extra == 'docs'
+Requires-Dist: mkdocs-material==9.5.47; extra == 'docs'
 Requires-Dist: mkdocs-minify-html-plugin==0.2.3; extra == 'docs'
 Requires-Dist: mkdocs==1.6.1; extra == 'docs'
 Requires-Dist: mkdocstrings-python==1.12.2; extra == 'docs'
@@ -67,7 +68,7 @@ Requires-Dist: pytest-html==4.1.1; extra == 'test'
 Requires-Dist: pytest-sugar==1.0.0; extra == 'test'
 Requires-Dist: pytest-timeout==2.3.1; extra == 'test'
 Requires-Dist: pytest-xdist==3.6.1; extra == 'test'
-Requires-Dist: pytest==8.3.3; extra == 'test'
+Requires-Dist: pytest==8.3.4; extra == 'test'
 Description-Content-Type: text/markdown
 
 # Waldiez
@@ -82,9 +83,8 @@ To a python script or a jupyter notebook with the corresponding [ag2](https://gi
 
 ## Features
 
-- Export .waldiez flows to .py or .ipynb
+- Convert .waldiez flows to .py or .ipynb
 - Run a .waldiez flow
-- Include a `logs` folder with the logs of the flow in csv format
 - Provide a custom [IOSStream](https://ag2ai.github.io/ag2/docs/reference/io/base#iostream) to handle input and output.
 
 ## Installation
@@ -106,10 +106,10 @@ python -m pip install git+https://github.com/waldiez/waldiez.git
 ### CLI
 
 ```bash
-# Export a Waldiez flow to a python script or a jupyter notebook
-waldiez --export /path/to/a/flow.waldiez --output /path/to/an/output/flow[.py|.ipynb]
-# Export and run the script, optionally force generation if the output file already exists
-waldiez /path/to/a/flow.waldiez --output /path/to/an/output/flow[.py] [--force]
+# Convert a Waldiez flow to a python script or a jupyter notebook
+waldiez convert --file /path/to/a/flow.waldiez --output /path/to/an/output/flow[.py|.ipynb]
+# Convert and run the script, optionally force generation if the output file already exists
+waldiez run --file /path/to/a/flow.waldiez --output /path/to/an/output/flow[.py] [--force]
 ```
 
 ### Using docker/podman
@@ -118,7 +118,7 @@ waldiez /path/to/a/flow.waldiez --output /path/to/an/output/flow[.py] [--force]
 CONTAINER_COMMAND=docker # or podman
 # pull the image
 $CONTAINER_COMMAND pull waldiez/waldiez
-# Export a Waldiez flow to a python script or a jupyter notebook
+# Convert a Waldiez flow to a python script or a jupyter notebook
 $CONTAINER_COMMAND run \
   --rm \
   -v /path/to/a/flow.waldiez:/flow.waldiez \
@@ -132,12 +132,16 @@ $CONTAINER_COMMAND run \
   -v /path/to/an/output:/output \
   --userns=keep-id \
   --security-opt label=disable \
-  waldiez/waldiez --export /flow.waldiez --output /output/flow[.py|.ipynb]
+  waldiez/waldiez convert --file /flow.waldiez --output /output/flow[.py|.ipynb]
 ```
 
 ```shell
-# Export and run the script
-$CONTAINER_COMMAND run --rm -v /path/to/a/flow.waldiez:/flow.waldiez -v /path/to/an/output:/output waldiez/waldiez /flow.waldiez --output /output/output[.py]
+# Convert and run the script
+$CONTAINER_COMMAND run \
+  --rm \
+  -v /path/to/a/flow.waldiez:/flow.waldiez \
+  -v /path/to/an/output:/output \
+  waldiez/waldiez run --file /flow.waldiez --output /output/output[.py]
 ```
 
 ### As a library
@@ -236,6 +240,7 @@ with WaldiezIOStream.set_default(io_stream):
 - [ag2 (formerly AutoGen)](https://github.com/ag2ai/ag2)
 - [juptytext](https://github.com/mwouts/jupytext)
 - [pydantic](https://github.com/pydantic/pydantic)
+- [typer](https://github.com/fastapi/typer)
 
 ## Known Conflicts
 

{waldiez-0.1.11.dist-info → waldiez-0.1.12.dist-info}/RECORD

@@ -1,11 +1,11 @@
 waldiez/__init__.py,sha256=ASGmxP3JcASIv89_tMYhYxvW0FlHK1jM0Nfb1hMN-z0,722
-waldiez/__main__.py,sha256=9xR-F2ohZcRPDG6KrM7cJpXciKX-u6WdL221ckyJ04k,112
-waldiez/_version.py,sha256=sJthgAdM_fnhfUw7CJUqaPJliLLYbXnDEyzn7i1rA9U,63
-waldiez/cli.py,sha256=wStRkt056Y-F2CcuD6Zlov-ooUpWndyNesV9s_MjyHU,4798
+waldiez/__main__.py,sha256=mUQWu4CF03Jbbscvcfb_9EFTnIMliJJJmAuWf0sRRZU,110
+waldiez/_version.py,sha256=Ghv_5N5tYHICAHt6PGEy61bfyUDKhsyhAFoFl4nZiNw,63
+waldiez/cli.py,sha256=6BefTHXqib-L_FTdYOAaUkv4DLYYpjBePdlCn2BEYi0,6307
 waldiez/conflict_checker.py,sha256=T5FA7hsxpuW0Byb4YyZQ3-uVxzNnoTQV199YRBKjvmE,707
 waldiez/exporter.py,sha256=iKe-l_Me8NRWsXHIdBcrOrnLT9XIyp4iYi4HLuuj2jA,9342
 waldiez/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-waldiez/runner.py,sha256=hBHgtfxcV7LlGMAwGEf7xbNp3_qEvFsnbTTnKfe-Y1g,11097
+waldiez/runner.py,sha256=v4A4NHdSnh96TQ5Vx1vs8UrTsshc2oAwDZrEHmq4RkU,11537
 waldiez/exporting/__init__.py,sha256=GMY7qTRpNmc7tpaCFNGLT5wX9eu26NvoNPuYX8MzP50,344
 waldiez/exporting/agents/__init__.py,sha256=v5KA112W_EFYwXE2TSBKYyO8rRKUOUAOpFS5CMSnfRs,110
 waldiez/exporting/agents/agent.py,sha256=d2ut2B90-aG4uBRhPWS7B4MKIvSJqQva6DjlXiqleVQ,7513
@@ -85,8 +85,8 @@ waldiez/models/model/model_data.py,sha256=pDPKUbltaXWjCuDArgwTOEHw_igfk_DkxzFzdn
 waldiez/models/skill/__init__.py,sha256=rU88bajKOGMYoHFcE8MP0jW9H0MswbQmvz5wxS35BYE,169
 waldiez/models/skill/skill.py,sha256=fhsAI413an2_d4DBIkf7dzEuWk6rGs2t4sl97a4dj20,3473
 waldiez/models/skill/skill_data.py,sha256=RTWn8Od6w7g-nRIpsS29sqZ8sPm5dCPiK7-qXmU-KD4,815
-waldiez-0.1.11.dist-info/METADATA,sha256=hzcUFwIJ4SXtYWeEbhfTNy8A7fkVupJFm5GJhfCbuOg,9288
-waldiez-0.1.11.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-waldiez-0.1.11.dist-info/entry_points.txt,sha256=5Po4yQXPa_QEdtTevpEBgr3rGoIvDMeQuJR2zqwBLBo,45
-waldiez-0.1.11.dist-info/licenses/LICENSE,sha256=VQEHM6WMQLRu1qaGl3GWsoOknDwro-69eGo4NLIJPIM,1064
-waldiez-0.1.11.dist-info/RECORD,,
+waldiez-0.1.12.dist-info/METADATA,sha256=iPiXFcDEttK2fhztm6G9PIenEs_wHMx-28CJaqTn3Vg,9353
+waldiez-0.1.12.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+waldiez-0.1.12.dist-info/entry_points.txt,sha256=5Po4yQXPa_QEdtTevpEBgr3rGoIvDMeQuJR2zqwBLBo,45
+waldiez-0.1.12.dist-info/licenses/LICENSE,sha256=VQEHM6WMQLRu1qaGl3GWsoOknDwro-69eGo4NLIJPIM,1064
+waldiez-0.1.12.dist-info/RECORD,,