semvec/pypi-packages huggingface dataset:
chatsky-ui 0.6.0
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.
License: Apache-2.0
Requires Python: !=2.7.*,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,!=3.8.*,>=3.9
Keywords: chatbots

# 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:
```bash
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:
```bash
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:
```bash
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.
```.env
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](https://deeppavlov.github.io/chatsky-ui/) to dig into the application code understanding.