https://github.com/cofactoryai/textbase

✨ Textbase is a simple framework for building AI chatbots. ✨
https://github.com/cofactoryai/textbase

hacktoberfest

Last synced: 28 days ago
JSON representation

✨ Textbase is a simple framework for building AI chatbots. ✨

• Host: GitHub
• URL: https://github.com/cofactoryai/textbase
• Owner: cofactoryai
• Created: 2023-07-26T08:27:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-27T19:12:19.000Z (12 months ago)
• Last Synced: 2024-10-01T11:22:31.271Z (about 1 month ago)
• Topics: hacktoberfest
• Language: Python
• Homepage: https://textbase.ai
• Size: 14.8 MB
• Stars: 1,274
• Watchers: 12
• Forks: 355
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        


  

    

  

  


  






    

        

    





    
✨ Textbase is a framework for building chatbots using NLP and ML. ✨




    



Just implement the `on_message` function in `main.py` and Textbase will take care of the rest :)

Since it is just Python you can use whatever models, libraries, vector databases and APIs you want.

Coming soon:

- [x] [PyPI package](https://pypi.org/project/textbase-client/)

- [x] Easy web deployment via [textbase-client deploy](docs/docs/deployment/deploy-from-cli.md)

- [ ] SMS integration

- [ ] Native integration of other models (Claude, Llama, ...)

![Demo Deploy GIF](assets/textbase-deploy.gif)

## Installation

Make sure you have `python version >=3.9.0`, it's always good to follow the [docs](https://docs.textbase.ai/get-started/installation) 👈🏻

### 1. Through pip

```bash

pip install textbase-client

```

### 2. Local installation

Clone the repository and install the dependencies using [Poetry](https://python-poetry.org/) (you might have to [install Poetry](https://python-poetry.org/docs/#installation) first).

For proper details see [here]()

```bash

git clone https://github.com/cofactoryai/textbase

cd textbase

poetry shell

poetry install

```

## Start development server

> If you're using the default template, **remember to set the OpenAI API key** in `main.py`.

Run the following command:

- if installed locally

    ```bash

    poetry run python textbase/textbase_cli.py test

    ```

- if installed through pip

    ```bash

    textbase-client test

    ```

Response:

```bash

Path to the main.py file: examples/openai-bot/main.py # You can create a main.py by yourself and add that path here. NOTE: The path should not be in quotes

```

Now go to the link in blue color which is shown on the CLI and you will be able to chat with your bot!

![Local UI](assets/test_command.png)

### `Other commands have been mentioned in the documentation website.` [Have a look](https://docs.textbase.ai/usage) 😃!

## Contributions

Contributions are welcome! Please open an issue or create a pull request.

Follow our [`contributions guide`](CONTRIBUTING.md) for more details!