Démarrage

Cette page vous explique les étapes d’installation du SDK, d’élaboration d’un projet et d’exécution locale de votre première fonction Python.

Prérequis

• Python 3.10 ou version ultérieure.
• L’ interface CLI et le SDKuipath installés avec pip.
• Un compte UiPath avec accès à Orchestrator (pour la publication et l'invocation).

Installer le SDK

pip install uipath

Vérifiez l'installation:

uipath --version

Élaborer un projet

Créez un nouveau projet de fonction:

uipath new my-function

Cela élaboration des fichiers que vous modifiez:

Fichier	Objectif
main.py	Votre logique fonctionnelle et les modèles Input/Output. Démarre en tant qu’exemple exécutable.
pyproject.toml	Métadonnées et dépendances du projet.
uipath.json	Déclare les points d'entrée appelables. L’élaboration enregistre main pour vous.

Écrivez votre première fonction

Remplacez la logique d’élaboration dans 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}!")

L’élaboration uipath.json indique déjà ce point d’entrée:

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

La clé (main) est le nom du point d'entrée utilisé dans les commandes CLI; la valeur fait référence au fichier et à la fonction. Mettez-le à jour uniquement si vous renommez la fonction ou ajoutez d'autres points d'entrée.

Générer le schéma du projet

Une fois que vos Input et Output sont définis, générez le schéma et les liaisons:

uipath init

Cela va lire votre code et uipath.json et générer:

Fichier	Objectif
entry-points.json	Le schéma JSON d’entrée/de sortie est dérivé de vos modèles, utilisés pour la liaison de variables.
bindings.json	Manifest de liaison de ressource, créé avec une structure vide uniquement lorsque le fichier n'existe pas déjà.

Réexécutez uipath init chaque fois que vous modifiez vos modèles Input ou Output. Elle régénère entry-points.json et ne modifie jamais bindings.json — les liaisons de ressources sont gérées manuellement. Pour ce qu'ils font et comment les déclarer, consultez Liaisons de ressources.

L’exécuter localement

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

Les exécutions locales résolvent les ressources de la plateforme via les entrées de bindings.json, vous permettant ainsi de tester les ressources et les compartiments Orchestrator réels avant de publier. Les mêmes entrées permettent de remapper chaque ressource lorsque le package s'exécute dans un autre locataire.

Prochaines étapes

• Créer des fonctions Python — schémas saisis, gestion des erreurs et plusieurs points d'entrée.
• Liaisons de ressources : déclarez les ressources de la plateforme que votre fonction atteint.
• Empaqueter et publier — déployer dans Orchestrator.