chatsky-ui 0.5.2

Chatsky-UI is GUI for Chatsky Framework, that is a free and open-source software stack for creating chatbots, released under the terms of Apache License 2.0.

Quick Start

System Requirements

Ensure you have Python version 3.9 or higher installed (Excluding 3.9.7).

Installation

To install the package and necessary dependencies, run the following command:

pip install chatsky-ui

Project Initiation

💡 You are encouraged to run chatsky.ui --help to explore the available CLI options.

Initialize your project by running:

chatsky.ui init

The chatsky.ui init command will start an interactive cookiecutter process to create a project based on a predefined template. The resulting project will be a simple example template that you can customize to suit your needs.

Running Your Project

To start your project, use the following command:

chatsky.ui run_app --project-dir <PROJECT-SLUG>  # Replace <PROJECT-SLUG> with the slug you specified during initialization

Configuring the chatsky-ui app

You may add a .env file in the root directory and configure any of following environment variables. The values shown below are the default ones.

HOST=0.0.0.0
PORT=8000
CONF_RELOAD=False
LOG_LEVEL=info

GRACEFUL_TERMINATION_TIMEOUT=2  # Waiting for process to stop
PING_PONG_TIMEOUT=0.5  # Waiting the process to response before it mark it as still `running`

# For tests:
BUILD_COMPLETION_TIMEOUT=10
RUN_RUNNING_TIMEOUT=5

Documentation

You can refer to the documentaion to dig into the application code understanding.