OpenWebUI/bot
1
0
Fork 0
mirror of https://github.com/open-webui/bot synced 2025-06-26 18:16:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refac

Browse Source
This commit is contained in:
Timothy Jaeryang Baek
2025-01-02 21:33:39 -08:00
parent e0efa290d6
commit 7f356751bb
6 changed files with 75 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -7,6 +7,19 @@ This repository provides an experimental boilerplate for building bots compatibl
- **Extensible Framework**: Designed as a foundation for further development, with plans to enhance APIs, developer tooling, and usability.
- **Asynchronous Communication**: Leverages Open WebUI Channels for event-driven workflows.
## 🛠️ Getting Started with Examples
This repository includes an `/examples` folder containing runnable example bots that demonstrate basic functionality.
To run an example, execute the corresponding module using the `-m` flag in Python. For example, to run the `ollama` example:
```bash
python -m examples.ollama
```
> **Note**: Ensure that your current working directory (PWD) is the root of this repository when running examples, as this is required for proper execution.
Replace `ollama` in the command above with the specific example you’d like to execute from the `/examples` folder.
## 🚧 Disclaimer
This project is an early-stage proof of concept. **APIs will break** and existing functionality may change as Open WebUI evolves to include native bot support. This repository is not production-ready and primarily serves experimental and exploratory purposes.