uipath-langchain 0.0.99__tar.gz → 0.0.100__tar.gz

{uipath_langchain-0.0.99 → uipath_langchain-0.0.100}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath-langchain
-Version: 0.0.99
+Version: 0.0.100
 Summary: UiPath Langchain
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-langchain-python
@@ -25,7 +25,7 @@ Requires-Dist: pydantic-settings>=2.6.0
 Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: requests>=2.23.3
 Requires-Dist: types-requests>=2.32.0.20241016
-Requires-Dist: uipath<2.1.0,>=2.0.28
+Requires-Dist: uipath<2.1.0,>=2.0.31
 Provides-Extra: langchain
 Description-Content-Type: text/markdown
 
@@ -38,6 +38,8 @@ A Python SDK that enables developers to build and deploy LangGraph agents to the
 
 This package is an extension to the [UiPath Python SDK](https://github.com/UiPath/uipath-python).
 
+This [quickstart guide](docs/quick_start.md) walks you through deploying your first agent to UiPath Cloud Platform.
+
 ## Requirements
 
 - Python 3.10 or higher

{uipath_langchain-0.0.99 → uipath_langchain-0.0.100}/README.md

@@ -7,6 +7,8 @@ A Python SDK that enables developers to build and deploy LangGraph agents to the
 
 This package is an extension to the [UiPath Python SDK](https://github.com/UiPath/uipath-python).
 
+This [quickstart guide](docs/quick_start.md) walks you through deploying your first agent to UiPath Cloud Platform.
+
 ## Requirements
 
 - Python 3.10 or higher

uipath_langchain-0.0.100/docs/quick_start.md

@@ -0,0 +1,144 @@
+# Quickstart Guide: UiPath LangChain Agents
+
+## Introduction
+
+This guide walks you through the process of setting up, creating, publishing, and running your first UiPath-LangChain Agent.
+
+## Prerequisites
+
+Ensure you have the following installed before proceeding:
+
+-   Python 3.10 or higher
+-   `pip` or `uv` package manager
+-   A UiPath Platform account with appropriate permissions
+
+## Step-by-Step Guide
+
+## Creating a New Project
+
+We recommend using `uv` for package management. To create a new project:
+
+```shell
+mkdir example
+cd example
+uv init . --python 3.10
+```
+This command creates a basic project structure.
+
+## Install the UiPath LangChain SDK
+
+Add the UiPath LangChain SDK to your project:
+
+```bash
+uv add uipath[langchain]
+```
+To verify the installation, run:
+
+```shell
+ uv run uipath -lv
+```
+
+## (Optional) Activate your virtual environment
+```shell
+# Windows
+.venv\Scripts\activate
+```
+or
+```shell
+# Unix-like Systems
+source .venv/bin/activate
+```
+> If you skip activating the virtual environment, prefix the upcoming commands with `uv run`.
+
+
+## Create Your First UiPath Agent
+
+Generate your first UiPath LangChain:
+
+```bash
+uipath new my-agent
+```
+This command creates the following files:
+
+| File Name        | Description                                                                                                                       |
+|------------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| `.env`           | Environment variables and secrets (this file will not be packed & published).                                                     |
+| `main.py`        | LangGraph agent code.                                                                                                             |
+| `uipath.json`    | Input/output json schemas and bindings.                                                                                           |
+| `langgraph.json` | [LangGraph](https://langchain-ai.github.io/langgraph/concepts/application_structure/#file-structure) specific configuration file. |
+| `agent.mermaid`  | Graph visual representation.                                                                                                      |
+
+## Set Up Environment Variables
+
+Before running the agent, set either `ANTHROPIC_API_KEY` or `OPENAI_API_KEY` in the previously created `.env` file:
+
+```
+ANTHROPIC_API_KEY=your_api_key_here
+```
+or
+```
+OPENAI_API_KEY=your_api_key_here
+```
+
+## Run the Agent Locally
+
+Execute the agent with a sample input:
+
+```bash
+uipath run agent '{"topic": "UiPath"}'
+```
+
+This command runs your agent locally and generates the report at standard output.
+
+## Pack and Publish the agent on UiPath Cloud Platform
+
+Follow these steps to publish and run your agent on UiPath Cloud Platform:
+
+### Authenticate with UiPath
+```bash
+uipath auth
+```
+
+### (Optional) Update author details in `pyproject.toml`
+```toml
+authors = [{ name = "John Doe", email = "john.doe@example.com" }]
+```
+
+### Package your project:
+```bash
+uipath pack
+```
+
+### Publish to your workspace
+```bash
+uipath publish --my-workspace
+```
+> Please note that a process will be auto-created only upon publishing to **my-workspace** package feed.
+
+### Configure environment variables using the provided link
+
+![Set Environment Variables](quick_start_images/cloud_env_var.png)
+
+## Invoke the Agent on UiPath Platform
+
+Invoke the agent in UiPath Cloud Platform:
+
+```bash
+uipath invoke agent '{"topic": "UiPath"}'
+```
+
+**Expected output:**
+```
+⠦ Loading configuration ...
+⠦ Starting job ...
+✨ Job started successfully!
+🔗 Monitor your job here: https://example.com
+```
+
+Use the provided link to monitor your job and view detailed traces.
+
+## Next steps
+
+Congratulations! You have successfully set up, created, published, and run a UiPath LangChain Agent. 🚀
+
+For more advanced agents and examples, please refer to our [samples section](../samples).

{uipath_langchain-0.0.99 → uipath_langchain-0.0.100}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "uipath-langchain"
-version = "0.0.99"
+version = "0.0.100"
 description = "UiPath Langchain"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"
 dependencies = [
-    "uipath>=2.0.28, <2.1.0",
+    "uipath>=2.0.31, <2.1.0",
     "langgraph>=0.2.70",
     "langchain-core>=0.3.34",
     "langgraph-checkpoint-sqlite>=2.0.3",

{uipath_langchain-0.0.99 → uipath_langchain-0.0.100}/src/uipath_langchain/_cli/cli_new.py

@@ -26,16 +26,16 @@ def generate_script(target_directory):
 def generate_pyproject(target_directory, project_name):
     project_toml_path = os.path.join(target_directory, "pyproject.toml")
     toml_content = f"""[project]
-                        name = "{project_name}"
-                        version = "0.0.1"
-                        description = "{project_name}"
-                        authors = [{{ name = "John Doe", email = "john.doe@myemail.com" }}]
-                        dependencies = [
-                            "uipath-langchain>=0.0.95",
-                            "langchain-anthropic>=0.3.8",
-                        ]
-                        requires-python = ">=3.10"
-                    """
+name = "{project_name}"
+version = "0.0.1"
+description = "{project_name}"
+authors = [{{ name = "John Doe", email = "john.doe@myemail.com" }}]
+dependencies = [
+    "uipath-langchain>=0.0.95",
+    "langchain-anthropic>=0.3.8",
+]
+requires-python = ">=3.10"
+"""
 
     with open(project_toml_path, "w") as f:
         f.write(toml_content)