uipath-openai-agents 0.0.1__tar.gz

uipath_openai_agents-0.0.1/.gitignore

@@ -0,0 +1,184 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+**/uipath.db
+**/.uipath
+**/**.nupkg
+**/__uipath/
+.claude/settings.local.json
+
+/.vscode/launch.json
+
+playground.py

uipath_openai_agents-0.0.1/.python-version

@@ -0,0 +1 @@
+3.11

uipath_openai_agents-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to UiPath SDK
+
+## Local Development Setup
+
+### Prerequisites
+
+1. **Install Python 3.13**:
+    - Download and install Python 3.13 from the official [Python website](https://www.python.org/downloads/)
+    - Verify the installation by running:
+        ```sh
+        python3.13 --version
+        ```
+
+    Alternative: [mise](https://mise.jdx.dev/lang/python.html)
+
+2. **Install [uv](https://docs.astral.sh/uv/)**:
+    ```sh
+    pip install uv
+    ```
+
+3. **Create a virtual environment in the current working directory**:
+    ```sh
+    uv venv
+    ```
+
+4. **Install dependencies**:
+    ```sh
+    uv sync --all-extras
+    ```
+
+See `just --list` for linting, formatting and build commands.
+
+
+### Use SDK Locally
+1. Create a folder on your own device `mkdir project; cd project`
+2. Initialize the python project `uv` `uv init . --python 3.11`
+3. Obtain the project path `PATH_TO_SDK=/Users/YOU_USER/uipath-integrations-python/packages/uipath-openai-agents/`
+4. Install the sdk in editable mode `uv add --editable ${PATH_TO_SDK}`
+
+:information_source: Instead of cloning the project into `.venv/lib/python3.11/site-packages/uipath-openai-agents`, this mode creates a file named `_uipath-openai-agents.pth` inside `.venv/lib/python3.11/site-packages`. This file contains the value of `PATH_TO_SDK`, which is added to `sys.path`—the list of directories where python searches for packages. (Run `python -c 'import sys; print(sys.path)'` to see the entries.)
+
+

uipath_openai_agents-0.0.1/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: uipath-openai-agents
+Version: 0.0.1
+Summary: UiPath OpenAI Agents SDK
+Project-URL: Homepage, https://uipath.com
+Project-URL: Repository, https://github.com/UiPath/uipath-llamaindex-python
+Maintainer-email: Marius Cosareanu <marius.cosareanu@uipath.com>, Cristian Pufu <cristian.pufu@uipath.com>
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.11
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: openai-agents>=0.6.5
+Requires-Dist: openai>=1.0.0
+Requires-Dist: openinference-instrumentation-openai-agents>=1.4.0
+Requires-Dist: uipath-runtime<0.6.0,>=0.5.0
+Requires-Dist: uipath<2.6.0,>=2.5.0
+Description-Content-Type: text/markdown
+
+# UiPath OpenAI Agents SDK
+
+Build intelligent AI agents with OpenAI's Agents framework and UiPath.
+
+## Installation
+
+```bash
+pip install uipath-openai-agents
+```
+
+## Quick Start
+
+See the [main repository documentation](../../docs/) for getting started guides and examples.
+
+## Features
+
+- **OpenAI Agents Integration**: Build agents using OpenAI's native Agents framework
+- **Agent Orchestration**: Multi-agent coordination and communication
+- **State Management**: Persistent agent state with SQLite sessions
+- **UiPath Integration**: Seamless integration with UiPath runtime and tooling
+
+## Status
+
+⚠️ **Early Development**: This package is in early development (v0.1.0). APIs may change as the OpenAI Agents framework evolves.
+
+## Documentation
+
+Full documentation is available in the [main repository](https://github.com/UiPath/uipath-llamaindex-python).
+
+## License
+
+See [LICENSE](../../LICENSE) in the repository root.

uipath_openai_agents-0.0.1/README.md

@@ -0,0 +1,32 @@
+# UiPath OpenAI Agents SDK
+
+Build intelligent AI agents with OpenAI's Agents framework and UiPath.
+
+## Installation
+
+```bash
+pip install uipath-openai-agents
+```
+
+## Quick Start
+
+See the [main repository documentation](../../docs/) for getting started guides and examples.
+
+## Features
+
+- **OpenAI Agents Integration**: Build agents using OpenAI's native Agents framework
+- **Agent Orchestration**: Multi-agent coordination and communication
+- **State Management**: Persistent agent state with SQLite sessions
+- **UiPath Integration**: Seamless integration with UiPath runtime and tooling
+
+## Status
+
+⚠️ **Early Development**: This package is in early development (v0.1.0). APIs may change as the OpenAI Agents framework evolves.
+
+## Documentation
+
+Full documentation is available in the [main repository](https://github.com/UiPath/uipath-llamaindex-python).
+
+## License
+
+See [LICENSE](../../LICENSE) in the repository root.

uipath_openai_agents-0.0.1/docs/quick_start.md

@@ -0,0 +1,301 @@
+# Quickstart Guide: UiPath OpenAI Agents
+
+## Introduction
+
+This guide provides step-by-step instructions for setting up, creating, publishing, and running your first UiPath OpenAI Agent.
+
+## Prerequisites
+
+Before proceeding, ensure you have the following installed:
+
+-   Python 3.11 or higher
+-   `pip` or `uv` package manager
+-   A UiPath Automation Cloud account with appropriate permissions
+-   An OpenAI API key
+
+/// info
+ **OpenAI** - Generate an OpenAI API key [here](https://platform.openai.com).
+   ///
+
+## Creating a New Project
+
+We recommend using `uv` for package management. To create a new project:
+
+//// tab | Linux, macOS, Windows Bash
+
+<!-- termynal -->
+
+```shell
+> mkdir example
+> cd example
+```
+
+////
+
+//// tab | Windows PowerShell
+
+<!-- termynal -->
+
+```powershell
+> New-Item -ItemType Directory -Path example
+> Set-Location example
+```
+
+////
+
+//// tab | uv
+    new: true
+
+<!-- termynal -->
+
+```shell
+# Initialize a new uv project in the current directory
+> uv init . --python 3.11
+
+# Create a new virtual environment
+# By default, uv creates a virtual environment in a directory called .venv
+> uv venv
+Using CPython 3.11.16 interpreter at: [PATH]
+Creating virtual environment at: .venv
+Activate with: source .venv/bin/activate
+
+# Activate the virtual environment
+# For Windows PowerShell/ Windows CMD: .venv\Scripts\activate
+# For Windows Bash: source .venv/Scripts/activate
+> source .venv/bin/activate
+
+# Install the uipath package
+> uv add uipath-openai-agents
+```
+
+////
+
+//// tab | pip
+
+<!-- termynal -->
+
+```shell
+# Create a new virtual environment
+> python -m venv .venv
+
+# Activate the virtual environment
+# For Windows PowerShell: .venv\Scripts\Activate.ps1
+# For Windows Bash: source .venv/Scripts/activate
+> source .venv/bin/activate
+
+# Upgrade pip to the latest version
+> python -m pip install --upgrade pip
+
+# Install the uipath package
+> pip install uipath-openai-agents
+```
+
+////
+
+## Create Your First UiPath Agent
+
+Generate your first UiPath OpenAI agent:
+
+<!-- termynal -->
+
+```shell
+> uipath new my-agent
+⠋ Creating new agent my-agent in current directory ...
+✓  Created 'main.py' file.
+✓  Created 'openai_agents.json' file.
+✓  Created 'pyproject.toml' file.
+🔧  Please ensure to define OPENAI_API_KEY in your .env file.
+💡  Initialize project: uipath init
+💡  Run agent: uipath run agent '{"message": "Hello"}'
+```
+
+This command creates the following files:
+
+| File Name        | Description                                                                                                                      |
+|------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| `main.py`        | OpenAI Agents code.                                                                                                            |
+| `openai_agents.json` | OpenAI Agents specific configuration file. |
+| `pyproject.toml` | Project metadata and dependencies as per [PEP 518](https://peps.python.org/pep-0518/).                                           |
+
+
+## Initialize Project
+
+<!-- termynal -->
+
+```shell
+> uipath init
+⠋ Initializing UiPath project ...
+✓   Created '.env' file.
+✓   Created 'agent.mermaid' file.
+✓   Created 'entry-points.json' file.
+```
+
+This command creates the following files:
+
+| File Name        | Description                                                                                                                       |
+| ---------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `.env`           | Environment variables and secrets (this file will not be packed & published).                                                     |
+| `uipath.json`    | Input/output JSON schemas and bindings.                                                                                           |
+| `agent.mermaid`  | Graph visual representation.                                                                                                      |
+
+## Set Up Environment Variables
+
+Before running the agent, configure `OPENAI_API_KEY` in the `.env` file:
+
+//// tab | Open AI
+
+```
+OPENAI_API_KEY=sk-proj-......
+```
+
+////
+
+## Authenticate With UiPath
+
+<!-- termynal -->
+
+```shell
+> uipath auth
+⠋ Authenticating with UiPath ...
+🔗 If a browser window did not open, please open the following URL in your browser: [LINK]
+👇 Select tenant:
+  0: Tenant1
+  1: Tenant2
+Select tenant number: 0
+Selected tenant: Tenant1
+✓  Authentication successful.
+```
+
+## Run The Agent Locally
+
+Execute the agent with a sample input:
+
+<!-- termynal -->
+
+```shell
+> uipath run agent '{"message": "Hello"}'
+{'response': 'Hello! How can I help you today?', 'agent_used': 'main'}
+✓  Successful execution.
+```
+
+This command runs your agent locally and displays the output in the standard output.
+
+/// warning
+Depending on the shell you are using, it may be necessary to escape the input json:
+
+/// tab | Bash/ZSH/PowerShell
+```console
+uipath run agent '{"message": "Hello"}'
+```
+///
+
+/// tab | Windows CMD
+```console
+uipath run agent "{""message"": ""Hello""}"
+```
+///
+
+/// tab | Windows PowerShell
+```console
+uipath run agent '{\"message\":\"Hello\"}'
+```
+///
+
+///
+
+/// attention
+
+For a shell agnostic option, please refer to the next section.
+
+///
+
+### (Optional) Run The Agent with a json File as Input
+
+The `run` command can also take a .json file as an input. You can create a file named `input.json` having the following content:
+
+```json
+{
+  "message": "Hello"
+}
+```
+
+Use this file as agent input:
+
+```shell
+> uipath run agent --file input.json
+```
+
+## Deploy the Agent to UiPath Automation Cloud
+
+Follow these steps to publish and run your agent to UiPath Automation Cloud:
+
+### (Optional) Customize the Package
+
+Update author details in `pyproject.toml`:
+
+```toml
+authors = [{ name = "Your Name", email = "your.name@example.com" }]
+```
+
+### Package Your Project
+
+<!-- termynal -->
+
+```shell
+> uipath pack
+⠋ Packaging project ...
+Name       : test
+Version    : 0.1.0
+Description: Add your description here
+Authors    : Your Name
+✓  Project successfully packaged.
+```
+
+### Publish To My Workspace
+
+<!-- termynal -->
+
+```shell
+> uipath publish --my-workspace
+⠙ Publishing most recent package: my-agent.0.0.1.nupkg ...
+✓  Package published successfully!
+⠦ Getting process information ...
+🔗 Process configuration link: [LINK]
+💡 Use the link above to configure any environment variables
+```
+
+/// info
+Please note that a process will be auto-created only upon publishing to **my-workspace** package feed.
+   ///
+
+Set the environment variables using the provided link.
+
+## Invoke the Agent on UiPath Automation Cloud
+
+<!-- termynal -->
+
+```shell
+> uipath invoke agent '{"message": "Hello"}'
+⠴ Loading configuration ...
+⠴ Starting job ...
+✨ Job started successfully!
+🔗 Monitor your job here: [LINK]
+```
+
+Use the provided link to monitor your job and view detailed traces.
+
+### (Optional) Invoke The Agent with a json File as Input
+
+The `invoke` command operates similarly to the `run` command, allowing you to use the same .json file defined
+in the [(Optional) Run the agent with a .json file as input](#optional-run-the-agent-with-a-json-file-as-input)
+section, as agent input:
+
+```shell
+> uipath invoke agent --file input.json
+```
+
+## Next Steps
+
+Congratulations! You have successfully set up, created, published, and run a UiPath OpenAI Agent. 🚀
+
+For more advanced agents and agent samples, please refer to our [samples section](https://github.com/UiPath/uipath-integrations-python/tree/main/packages/uipath-openai-agents/samples) in GitHub.

uipath_openai_agents-0.0.1/pyproject.toml

@@ -0,0 +1,99 @@
+[project]
+name = "uipath-openai-agents"
+version = "0.0.1"
+description = "UiPath OpenAI Agents SDK"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "aiosqlite>=0.20.0",
+    "openai>=1.0.0",
+    "openai-agents>=0.6.5",
+    "openinference-instrumentation-openai-agents>=1.4.0",
+    "uipath>=2.5.0, <2.6.0",
+    "uipath-runtime>=0.5.0, <0.6.0",
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+maintainers = [
+    { name = "Marius Cosareanu", email = "marius.cosareanu@uipath.com" },
+    { name = "Cristian Pufu", email = "cristian.pufu@uipath.com" }
+]
+
+[project.entry-points."uipath.middlewares"]
+register = "uipath_openai_agents.middlewares:register_middleware"
+
+[project.entry-points."uipath.runtime.factories"]
+openai-agents = "uipath_openai_agents.runtime:register_runtime_factory"
+
+[project.urls]
+Homepage = "https://uipath.com"
+Repository = "https://github.com/UiPath/uipath-llamaindex-python"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.14.1",
+    "ruff>=0.9.4",
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "pytest-mock>=3.11.1",
+    "pre-commit>=4.1.0",
+    "pytest-asyncio>=1.0.0",
+]
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"*" = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.mypy]
+plugins = [
+  "pydantic.mypy"
+]
+exclude = [
+    "samples/.*"
+]
+follow_imports = "silent"
+warn_redundant_casts = true
+warn_unused_ignores = false
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+disallow_untyped_defs = false
+
+[[tool.mypy.overrides]]
+module = "agents"
+ignore_missing_imports = true
+ignore_errors = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+addopts = "-ra -q"
+asyncio_default_fixture_loop_scope = "function"
+asyncio_mode = "auto"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true