Skip to content

README_ru.md

Latest commit

 

History

History
88 lines (69 loc) · 2.99 KB

README_ru.md

File metadata and controls

88 lines (69 loc) · 2.99 KB

← Назад к корню платформы

NativeBPM Python SDK

Официальный Python Client SDK для облачного движка NativeBPM.

Установка

Чтобы установить пакет из публичного реестра GitLab PyPI Package Registry:

pip install nativebpm-sdk --extra-index-url https://gitlab.com/api/v4/projects/nativebpm%2Fsdk/packages/pypi/simple

Для локальной разработки:

pip install -e .

Запуск тестов

Для локального запуска тестов Python SDK:

# Убедитесь, что установлен pytest
pip install pytest pytest-asyncio
pytest

Пример использования

Python SDK содержит полностью типизированную обертку Fluent API вокруг моделей данных Pydantic V2.

from nativebpm import Client

# Инициализация клиента
client = Client(base_url="http://localhost:8080", token="your-api-token")

# 1. Получение списка развернутых определений процессов
definitions = client.definitions().list().send()
for d in definitions:
    print(f"Process: {d.name} (ID: {d.id})")

# 2. Запуск нового инстанса процесса с бизнес-ключом и переменными
variables = {"priority": "high", "amount": 1200}
instance = (
    client.instances()
    .start("order-processing")
    .business_key("ORD-4501")
    .variables(variables)
    .send()
)
print(f"Started instance: {instance.id}")

Руководство для разработчиков: Публикация в GitLab Package Registry

Автоматическая публикация через CI/CD

Этот пакет автоматически собирается и публикуется в GitLab Package Registry при каждом пуше git-тега, соответствующего шаблону sdk/python/v*. Например:

git tag sdk/python/v1.0.0
git push origin sdk/python/v1.0.0

Ручная публикация

Для публикации релиза вручную:

  1. Выполните сборку: 
    pip install build twine
python -m build
  2. Загрузите собранные пакеты с помощью Twine:
    • Используя личный токен доступа (Personal Access Token): 
      twine upload --repository-url https://gitlab.com/api/v4/projects/nativebpm%2Fsdk/packages/pypi \
  -u your_gitlab_username \
  -p your_personal_access_token \
  dist/*
    • Используя токен развертывания проекта (Deploy Token): 
      twine upload --repository-url https://gitlab.com/api/v4/projects/nativebpm%2Fsdk/packages/pypi \
  -u gitlab+deploy-token-name \
  -p deploy_token_password \
  dist/*