Introdução

Esta página orienta você pela instalação do SDK, pela estruturação de um projeto e pela execução de sua primeira função Python localmente.

Pré-requisitos

• Python 3.10 ou posterior.
• A CLI e o SDKuipath , instalados com pip.
• Uma conta da UiPath com acesso ao Orchestrator (para publicar e invocar).

Instale o SDK

pip install uipath

Verifique a instalação:

uipath --version

Estruturar um projeto

Crie um novo projeto de função:

uipath new my-function

Isso estrutura os arquivos que você edita:

de transações	Finalidade
main.py	Sua lógica de função e os modelos Input/Output. Inicia como um exemplo executável.
pyproject.toml	Metadados e dependências do projeto.
uipath.json	Declara os pontos de entrada chamáveis. O suporte registra main para você.

Escreva sua primeira função

Substitua a lógica com framework em: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}!")

O com estrutura de uipath.json já declara este ponto de entrada:

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

A chave (main) é o nome do ponto de entrada usado em comandos da CLI; o valor faz referência ao arquivo e à função. Atualize-o apenas se você renomear a função ou adicionar mais pontos de entrada.

Gerar o esquema do projeto

Depois que Input e Output forem definidos, gere o esquema e as associações:

uipath init

Isso lê seu código e uipath.json e gera:

de transações	Finalidade
entry-points.json	Esquema JSON de entrada/saída derivados de seus modelos, usado para associação de variáveis.
bindings.json	Resource binding manifest, created with an empty structure only when the file does not already exist.

Re-run uipath init whenever you change your Input or Output models. It regenerates entry-points.json and never modifies bindings.json — resource bindings are maintained by hand. For what they do and how to declare them, see Resource bindings.

Executar localmente

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

Local runs resolve platform resources through the entries in bindings.json, so you can test against real Orchestrator assets and buckets before publishing. The same entries are what let each resource be remapped when the package runs in another tenant.

Próximas Etapas

• Crie funções do Python — esquemas digitados, tratamento de erros e vários pontos de entrada.
• Resource bindings — declare the platform resources your function reaches.
• Empacotar e publicar — implante no Orchestrator.