Установка фреймворка


Работа со SmartApp Framework начинается с установки фреймворка и запуска проекта. Перед установкой ознакомьтесь с рекомендациями и ограничениями.

Для установки фреймворка выполните следующую команду:

python -m pip install git+https://github.com/sberdevices/smart_app_framework@main

где main - это название ветки и/или коммита.

Создание проекта

Установленный фреймворк предоставляет возможность создавать следующие смартапы:

  • chat app - диалоговые смартапы;
  • canvas app - смартапы со сценариями и веб-приложением.

Для создания нового проекта выполните следующую команду:

python -m smart_kit create_app <YOUR_APP_NAME>

После выполнения команды новый проект появится в текущей директории.

Работа с проектом возможна с помощью следующих модулей:

  • <YOUR_APP_NAME>/manage.py — модуль для запуска и управления проектом;
  • <YOUR_APP_NAME>/app_config.py — модуль для работы с файлом конфигурации.

Запуск тестового сценария

Чтобы увидеть список возможных команд для работы с проектом, выполните следующий запрос:

python manage.py help

В списке отобразятся следующие команды:

  • local_testing - локальное тестирование;
  • tests - прогон функциональных тестов;
  • run_app - запуск сервиса (используется на сервере для запуска смартапа).

После настройки проекта вы можете запустить тестовый сценарий и посмотреть, как он работает:

$python manage.py local_testing

Текущий сценарий: template_app_hello
Привет! Введите help или ? для вызова списка команд.

> привет и тебе

Подробнее о тестировании сценария.