Metadata-Version: 2.1
Name: dash-chat-components
Version: 0.1.0
Summary: Chat components for Plotly Dash
Home-page: https://github.com/andriiryzhkov/dash-chat-components
Author: Andrii Ryzhkov <andrii.ryzhkov@gmail.com>
License: MIT
Project-URL: Bug Reports, https://github.com/andriiryzhkov/dash-chat-components/issues
Project-URL: Source, https://github.com/andriiryzhkov/dash-chat-components.git
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Dash
Classifier: Topic :: Communications :: Chat
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7, <4
Description-Content-Type: text/markdown
License-File: LICENSE

# Dash Chat Components

dash_chat_components is a library of chat components for Plotly Dash, that makes it easier to build conversational apps.

## Installation

```shell
pip install dash_chat_components
```

## Development
### Getting Started

1. Create a new python environment:
   ```shell
   python -m venv venv
   . venv/bin/activate
   ```
   _Note: venv\Scripts\activate for windows_

2. Install python dependencies:
   ```shell
   pip install -r requirements.txt
   ```
3. Install npm packages:
   1. Optional: use [nvm](https://github.com/nvm-sh/nvm) to manage node version:
      ```shell
      nvm install
      nvm use
      ```
   2. Install:
      ```shell
      npm install
      ```
4. Build:
   ```shell
   npm run build
   ```

### Component Code

### Publish

If publish on npm:
```shell
npm build
npm publish
```

### Justfile

Alternatively, use the provided [just](https://github.com/casey/just) commands:

1. Create a Python environment from previous step 1 and install:
   ```shell
   just install
   ```
2. Build
   ```shell
   just build
   ```
3. Publish
   ```shell
   just publish
   ```
4. See all commands with `just -l`
