Primeros pasos

Esta página te guía a través de la instalación del SDK, el andamiaje de un proyecto y la ejecución de tu primera función Python localmente.

Requisitos previos

• Python 3.10 o posterior.
• La CLIuipath y el SDK, instalados con pip.
• Una cuenta de UiPath con acceso a Orchestrator (para publicar e invocar).

Instalar el SDK

pip install uipath

Verifica la instalación:

uipath --version

Andamio de un proyecto

Crea un nuevo proyecto de función:

uipath new my-function

Esto aplica andamios a los archivos que editas:

Archivo	Propósito
main.py	Tu lógica de función y los modelos Input/Output. Se inicia como un ejemplo ejecutable.
pyproject.toml	Metadatos y dependencias del proyecto.
uipath.json	Declara los puntos de entrada a los que se puede llamar. El andamio registra main por ti.

Escribe tu primera función

Reemplaza la lógica andamiada en main.py:

from pydantic.dataclasses import dataclass


@dataclass
class Input:
    message: str = ""


@dataclass
class Output:
    reply: str = ""


def main(input: Input) -> Output:
    return Output(reply=f"Hello, {input.message}!")

El uipath.json andamiado ya declara este punto de entrada:

{
  "functions": {
    "main": "main.py:main"
  }
}

La clave (main) es el nombre del punto de entrada utilizado en los comandos CLI; el valor hace referencia al archivo y la función. Actualízala solo si cambias el nombre de la función o añades más puntos de entrada.

Generar el esquema del proyecto

Una vez definidos tus Input y Output, genera el esquema y los enlaces:

uipath init

Esto lee tu código y uipath.json y genera:

Archivo	Propósito
entry-points.json	Esquema JSON de entrada/salida derivado de tus modelos, utilizado para la vinculación de variables.
bindings.json	Manifiesto de vinculación de recursos, creado con una estructura vacía solo cuando el archivo aún no existe.

Vuelve a ejecutar uipath init cada vez que cambies tus modelos Input o Output. Regenera entry-points.json y nunca modifica bindings.json: las vinculaciones de recursos se mantienen a mano. Para saber qué hacen y cómo declararlos, consulta Vinculaciones de recursos.

Ejecutarlo localmente

uipath run main '{"message": "world"}'

Las ejecuciones locales resuelven los recursos de la plataforma a través de las entradas en bindings.json, para que puedas probar con activos y depósitos reales de Orchestrator antes de publicar. Las mismas entradas son las que permiten reasignar cada recurso cuando el paquete se ejecuta en otro tenant.

Próximos pasos

• Crear funciones de Python : esquemas tipados, gestión de errores y múltiples puntos de entrada.
• Vinculaciones de recursos : declara los recursos de la plataforma a los que llega tu función.
• Empaquetar y publicar : implementar en Orchestrator.