waldiez 0.1.0__tar.gz

waldiez-0.1.0/.gitignore

@@ -0,0 +1,26 @@
+.local/
+.venv/
+.cache/
+build/
+dist/
+site/
+reports/
+waldiez_out/
+**/logs/
+**/tmp/
+**/documents/
+*.log
+*.db
+*.sqlite3
+__pycache__/
+*.py[cod]
+*.egg
+.pytest_cache/
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.ruff_cache/
+.DS_Store
+.coverage
+**/*.coverage*
+**/*.ffs_db

waldiez-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Waldiez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

waldiez-0.1.0/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.3
+Name: waldiez
+Version: 0.1.0
+Summary: waldiez
+Project-URL: homepage, https://waldiez.github.io/py/
+Project-URL: repository, https://github.com/waldiez/py.git
+Author-email: Panagiotis Kasnesis <pkasnesis@thingenious.io>, Lazaros Toumanidis <laztoum@protonmail.com>
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: <3.13,>=3.10
+Requires-Dist: autogen-agentchat==0.2.37
+Requires-Dist: jupytext
+Requires-Dist: twisted==24.7.0
+Provides-Extra: autogen-extras
+Requires-Dist: autogen-agentchat[anthropic]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[bedrock]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[gemini]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[groq]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[mistral]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[retrievechat-couchbase]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[retrievechat-mongodb]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[retrievechat-pgvector]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[retrievechat-qdrant]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[retrievechat]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[together]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: autogen-agentchat[websurfer]==0.2.37; extra == 'autogen-extras'
+Requires-Dist: chromadb==0.5.15; extra == 'autogen-extras'
+Requires-Dist: fastembed==0.4.1; extra == 'autogen-extras'
+Requires-Dist: pgvector==0.3.5; extra == 'autogen-extras'
+Requires-Dist: psycopg[binary]>=3.2.3; extra == 'autogen-extras'
+Requires-Dist: pymongo==4.10.1; extra == 'autogen-extras'
+Requires-Dist: qdrant-client==1.12.0; extra == 'autogen-extras'
+Provides-Extra: dev
+Requires-Dist: autoflake==2.3.1; extra == 'dev'
+Requires-Dist: bandit==1.7.10; extra == 'dev'
+Requires-Dist: black[jupyter]==24.10.0; extra == 'dev'
+Requires-Dist: flake8==7.1.1; extra == 'dev'
+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: python-dotenv==1.0.1; extra == 'dev'
+Requires-Dist: ruff==0.7.1; extra == 'dev'
+Requires-Dist: types-pyyaml==6.0.12; extra == 'dev'
+Requires-Dist: yamllint==1.35.1; extra == 'dev'
+Provides-Extra: docs
+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.6; extra == 'docs'
+Requires-Dist: mkdocs-material==9.5.42; 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'
+Requires-Dist: mkdocstrings[crystal,python]==0.26.2; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-cov==5.0.0; extra == 'test'
+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'
+Description-Content-Type: text/markdown
+
+# Waldiez
+
+![CI Build](https://github.com/waldiez/py/actions/workflows/main.yaml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/waldiez/py/badge.svg)](https://coveralls.io/github/waldiez/py)
+
+Translate a Waldiez flow:
+
+[![Flow](./docs/flow.png)](./docs/flow.png)
+
+To a python script or a jupyter notebook with the corresponding [autogen](https://github.com/microsoft/autogen/) agents and chats.
+
+## Features
+
+- Export .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://autogen-ai.github.io/autogen/docs/reference/io/base#iostream) to handle input and output.
+
+## Installation
+
+<!-- 
+On PyPI:
+
+```bash
+python -m pip install waldiez
+``` -->
+
+From this repository:
+
+```bash
+python -m pip install git+https://github.com/waldiez/py.git
+```
+
+## Usage
+
+### 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[.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[.py] [--force]
+```
+
+### As a library
+
+#### Export a flow
+
+```python
+# Export a Waldiez flow to a python script or a jupyter notebook
+from waldiez import WaldiezExporter
+flow_path = "/path/to/a/flow.waldiez"
+output_path = "/path/to/an/output.py"  # or .ipynb
+exporter = WaldiezExporter.load(flow_path)
+exporter.export(output_path)
+```
+  
+#### Run a flow
+
+```python
+# Run a flow
+from waldiez import WaldiezRunner
+flow_path = "/path/to/a/flow.waldiez"
+output_path = "/path/to/an/output.py"
+runner = WaldiezRunner.load(flow_path)
+runner.run(output_path=output_path)
+```
+
+#### Run a flow with a custom IOStream
+
+```python
+# Run the flow with a custom IOStream
+from waldiez import WaldiezIOStream, WaldiezRunner
+
+flow_path = "/path/to/a/flow.waldiez"
+output_path = "/path/to/an/output.py"
+
+def print_function(*values, **args) -> None:
+    """A custom print function."""
+    print(values)
+
+def on_prompt_input(prompt: str) -> str:
+    """A custom input function."""
+    return input(prompt)
+
+io_stream = WaldiezIOStream(
+    print_function=print_function,
+    on_prompt_input=on_prompt_input,
+    input_timeout=30,
+)
+with WaldiezIOStream.set_default(io_stream):
+    runner = WaldiezRunner.load(flow_path)
+    runner.run(stream=io_stream, output_path=output_path)
+
+io_stream.close()
+
+```
+
+### Tools
+
+- [autogen](https://github.com/microsoft/autogen/)
+- [juptytext](https://github.com/mwouts/jupytext)
+- [twisted](https://github.com/twisted/twisted)
+- [pydantic](https://github.com/pydantic/pydantic)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

waldiez-0.1.0/README.md

@@ -0,0 +1,107 @@
+# Waldiez
+
+![CI Build](https://github.com/waldiez/py/actions/workflows/main.yaml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/waldiez/py/badge.svg)](https://coveralls.io/github/waldiez/py)
+
+Translate a Waldiez flow:
+
+[![Flow](./docs/flow.png)](./docs/flow.png)
+
+To a python script or a jupyter notebook with the corresponding [autogen](https://github.com/microsoft/autogen/) agents and chats.
+
+## Features
+
+- Export .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://autogen-ai.github.io/autogen/docs/reference/io/base#iostream) to handle input and output.
+
+## Installation
+
+<!-- 
+On PyPI:
+
+```bash
+python -m pip install waldiez
+``` -->
+
+From this repository:
+
+```bash
+python -m pip install git+https://github.com/waldiez/py.git
+```
+
+## Usage
+
+### 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[.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[.py] [--force]
+```
+
+### As a library
+
+#### Export a flow
+
+```python
+# Export a Waldiez flow to a python script or a jupyter notebook
+from waldiez import WaldiezExporter
+flow_path = "/path/to/a/flow.waldiez"
+output_path = "/path/to/an/output.py"  # or .ipynb
+exporter = WaldiezExporter.load(flow_path)
+exporter.export(output_path)
+```
+  
+#### Run a flow
+
+```python
+# Run a flow
+from waldiez import WaldiezRunner
+flow_path = "/path/to/a/flow.waldiez"
+output_path = "/path/to/an/output.py"
+runner = WaldiezRunner.load(flow_path)
+runner.run(output_path=output_path)
+```
+
+#### Run a flow with a custom IOStream
+
+```python
+# Run the flow with a custom IOStream
+from waldiez import WaldiezIOStream, WaldiezRunner
+
+flow_path = "/path/to/a/flow.waldiez"
+output_path = "/path/to/an/output.py"
+
+def print_function(*values, **args) -> None:
+    """A custom print function."""
+    print(values)
+
+def on_prompt_input(prompt: str) -> str:
+    """A custom input function."""
+    return input(prompt)
+
+io_stream = WaldiezIOStream(
+    print_function=print_function,
+    on_prompt_input=on_prompt_input,
+    input_timeout=30,
+)
+with WaldiezIOStream.set_default(io_stream):
+    runner = WaldiezRunner.load(flow_path)
+    runner.run(stream=io_stream, output_path=output_path)
+
+io_stream.close()
+
+```
+
+### Tools
+
+- [autogen](https://github.com/microsoft/autogen/)
+- [juptytext](https://github.com/mwouts/jupytext)
+- [twisted](https://github.com/twisted/twisted)
+- [pydantic](https://github.com/pydantic/pydantic)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

waldiez-0.1.0/pyproject.toml

@@ -0,0 +1,302 @@
+[project]
+name = "waldiez"
+description = 'waldiez'
+authors = [
+  { name = 'Panagiotis Kasnesis', email = 'pkasnesis@thingenious.io' },
+  { name= 'Lazaros Toumanidis', email= 'laztoum@protonmail.com' },
+]
+readme = "README.md"
+requires-python = '>=3.10,<3.13'
+dynamic = ["version"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: OS Independent",
+  "Intended Audience :: Science/Research",
+  "Intended Audience :: Developers",
+]
+dependencies = [
+    "jupytext",
+    "autogen-agentchat==0.2.37",
+    "twisted==24.7.0",
+]
+
+[project.urls]
+homepage = 'https://waldiez.github.io/py/'
+repository = 'https://github.com/waldiez/py.git'
+
+[tool.hatch.build.targets.sdist]
+packages = ["waldiez", "waldiez.*"]
+exclude = [ "**/example.py", ".gitignore" ]
+
+[tool.hatch.build.targets.wheel]
+packages = ["waldiez", "waldiez.*"]
+exclude = [ "**/example.py" ]
+
+[project.optional-dependencies]
+dev = [
+    'autoflake==2.3.1',
+    'bandit==1.7.10',
+    'black[jupyter]==24.10.0',
+    'flake8==7.1.1',
+    'isort==5.13.2',
+    'mypy==1.13.0',
+    'pre-commit==4.0.1',
+    'pydocstyle==6.3.0',
+    'pylint==3.3.1',
+    'python-dotenv==1.0.1',
+    'ruff==0.7.1',
+    'types-PyYAML==6.0.12',
+    'yamllint==1.35.1',
+]
+autogen_extras =[
+    'chromadb==0.5.15',
+    'fastembed==0.4.1',
+    'pgvector==0.3.5',
+    'psycopg[binary]>=3.2.3',
+    'autogen-agentchat[retrievechat]==0.2.37',
+    'autogen-agentchat[retrievechat-pgvector]==0.2.37',
+    'autogen-agentchat[retrievechat-mongodb]==0.2.37',
+    'autogen-agentchat[retrievechat-qdrant]==0.2.37',
+    'autogen-agentchat[retrievechat-couchbase]==0.2.37',
+    'autogen-agentchat[gemini]==0.2.37',
+    'autogen-agentchat[together]==0.2.37',
+    'autogen-agentchat[anthropic]==0.2.37',
+    'autogen-agentchat[mistral]==0.2.37',
+    'autogen-agentchat[groq]==0.2.37',
+    'autogen-agentchat[bedrock]==0.2.37',
+    'autogen-agentchat[websurfer]==0.2.37',
+    'pymongo==4.10.1',
+    'qdrant-client==1.12.0',
+]
+test = [
+    'pytest==8.3.3',
+    'pytest-cov==5.0.0',
+    'pytest-html==4.1.1',
+    'pytest-sugar==1.0.0',
+    'pytest-timeout==2.3.1',
+    'pytest-xdist==3.6.1',
+]
+docs = [
+  'mdx-include==1.4.2',
+  'mdx_truly_sane_lists==1.3',
+  'mkdocs==1.6.1',
+  'mkdocs-jupyter==0.25.1',
+  'mkdocs-macros-plugin==1.3.6',
+  'mkdocs-material==9.5.42',
+  'mkdocs-minify-html-plugin==0.2.3',
+  'mkdocstrings[crystal,python]==0.26.2',
+  'mkdocstrings-python==1.12.2'
+]
+
+[project.scripts]
+waldiez = 'waldiez.cli:main'
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+[tool.hatch.version]
+path = "waldiez/_version.py"
+# black
+[tool.black]
+line-length = 80
+skip-string-normalization=true
+include = '''
+    \.pyi?$
+'''
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | .local
+  | _build
+  | __init__.py
+  | .local
+  | examples
+)/
+'''
+
+# mypy
+[tool.mypy]
+files = '.'
+show_error_codes = true
+# xcode/dmypy: follow-imports=silent not supported
+# follow_imports = 'skip'
+platform = 'linux'
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = false
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+ignore_missing_imports = false
+no_implicit_reexport = true
+strict_optional = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true
+plugins = [
+  'pydantic.mypy'
+]
+#   'mypy_zope:plugin'
+# ]
+exclude = [
+    '.venv',
+    '.local',
+    'examples',
+]
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+# isort
+[tool.isort]
+profile ='black'
+skip=[
+    '.venv',
+    '.local',
+    'examples',
+]
+include_trailing_comma=true
+force_grid_wrap=0
+use_parentheses=true
+line_length=80
+
+# pydocstyle
+[tool.pydocstyle]
+match-dir='([^!(.venv)].*)([^!(.local)].*)([^!(examples)].*)'
+
+# pylint
+[tool.pylint.master]
+load-plugins = [
+    'pylint.extensions.mccabe',
+    'pylint.extensions.redefined_variable_type',
+    'pylint.extensions.broad_try_clause',
+    'pylint.extensions.no_self_use',
+    'pylint.extensions.docparams',
+]
+extension-pkg-whitelist= []
+# reports=true
+recursive=true
+fail-under=8.0
+ignore=["CVS"]
+ignore-paths = [
+    ".venv",
+    ".local*",
+    "examples",
+]
+
+unsafe-load-any-extension="no"
+
+[tool.pylint.messages_control]
+enable=["c-extension-no-member"]
+[tool.pylint.fotmat]
+max-line-length=80
+[tool.pylint.similarities]
+ignore-imports="yes"
+ignore-signatures="yes"
+min-similarity-lines=10
+[tool.pylint.broad_try_clause]
+max-try-statements=3
+[tool.pylint.design]
+max-args=10
+max-attributes=10
+max-positional-arguments=10
+[tool.pylint.string]
+check-quote-consistency = true
+check-str-concat-over-line-jumps = true
+[tool.pylint.parameter_documentation]
+accept-no-param-doc=false
+accept-no-raise-doc=false
+accept-no-return-doc=false
+accept-no-yields-doc=false
+# Possible choices: ['sphinx', 'epytext', 'google', 'numpy', 'default']
+default-docstring-type = "numpy"
+
+# bandit
+[tool.bandit]
+exclude_dirs = [
+    ".venv",
+    ".local",
+    "examples"
+]
+# B104: bind to all interfaces (0.0.0.0)
+# B110: allow pass on try/except
+# B404: allow import subprocess
+# B602, B603: allow shell=True (subprocess,popen)
+skips = ['B104', 'B110', 'B404', 'B602', 'B603' ]
+[tool.bandit.assert_used]
+skips = ['*_test.py', '*/test_*.py']
+
+
+# ruff
+[tool.ruff]
+line-length = 80
+extend-exclude = [
+    ".venv",
+    ".local",
+    "examples",
+]
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "Q"]
+ignore = []
+# # Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# # Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# exclude = ["*.pyi", "*.j2"]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+line-ending = "lf"
+
+# pytest
+[tool.pytest.ini_options]
+# filterwarnings = []
+python_files = [
+    "tests.py",
+    "test_*.py",
+    "*_tests.py",
+]
+addopts = """
+    -d \
+    -n auto \
+    --exitfirst \
+    --durations=10 \
+    --color=yes \
+    --timeout=30
+"""
+
+
+# coverage
+[tool.coverage.run]
+omit = [
+  "example.py",
+]
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "if __name__ == .__main__.:",
+]
+fail_under = 80
+precision = 2

waldiez-0.1.0/waldiez/__init__.py

@@ -0,0 +1,15 @@
+"""Waldiez package."""
+
+from ._version import __version__
+from .exporter import WaldiezExporter
+from .io_stream import WaldiezIOStream
+from .models import Waldiez
+from .runner import WaldiezRunner
+
+__all__ = [
+    "Waldiez",
+    "WaldiezExporter",
+    "WaldiezIOStream",
+    "WaldiezRunner",
+    "__version__",
+]

waldiez-0.1.0/waldiez/__main__.py

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

waldiez-0.1.0/waldiez/_version.py

@@ -0,0 +1,3 @@
+"""Version information for Waldiez."""
+
+__version__ = "0.1.0"