Metadata-Version: 2.4
Name: PyBenChatBot
Version: 1.0.1
Summary: PyBEN ChatBot enables anyone to run a custom chatbot on its own python module
Author: Ben Moskovitch
Author-email: Ben Moskovitch <darkflameben@gmail.com>
Maintainer-email: Ben Moskovitch <darkflameben@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/DarkFlameBEN/PyBenChatBot
Keywords: python,Chatbot,utils,utilities,automation,automation-tools
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi
Requires-Dist: chromadb
Requires-Dist: uvicorn
Requires-Dist: sentence_transformers
Dynamic: license-file

# PyBenChatBot
![GitHub License](https://img.shields.io/github/license/DarkFlameBEN/pybenchatbot)
[![PyPI - Version](https://img.shields.io/pypi/v/pybenchatbot)](https://pypi.org/project/pybenchatbot/)
![python suggested version](https://img.shields.io/badge/python-3.13.7-red.svg)
![python minimum version](https://img.shields.io/badge/python(min)-3.9+-red.svg)
![platforms](https://img.shields.io/badge/Platforms-Linux%20|%20Windows%20|%20Mac%20-purple.svg)

## Introduction
PyBEN ChatBot enables anyone to run a custom chatbot on its own python module

## Table of contents
1. [Getting started](#getting-started)
2. [Usage](#usage)

## Getting started

### Installation
Win:
> python -m pip install pybenchatbot -U

macOS:
> python3 -m pip install pybenchatbot -U

## Usage
The package is intended to be run as a module from cli.

Running the command will create a local webserver on the requested port. 
The webserver can be accessed at http://127.0.0.1:8000/

Chatbot on your local repository (Run from workspace or specify the path):
> python -m pybenchatbot
> python -m pybenchatbot --target ./myproject --port 8000
 
Chatbot on a specific module:
> python -m pybenchatbot -t pybenutils -p 8000

Activation time might take a few seconds while the module is being indexed.
