https://github.com/dalssoft/assistant-tui
ATUI - Assistant Textual User Interface
https://github.com/dalssoft/assistant-tui
assistant openai python textual tui
Last synced: 5 months ago
JSON representation
ATUI - Assistant Textual User Interface
- Host: GitHub
- URL: https://github.com/dalssoft/assistant-tui
- Owner: dalssoft
- Created: 2023-12-19T17:31:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T23:33:33.000Z (almost 2 years ago)
- Last Synced: 2025-05-07T22:45:39.031Z (5 months ago)
- Topics: assistant, openai, python, textual, tui
- Language: Python
- Homepage:
- Size: 4.84 MB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ATUI - Assistant Textual User Interface
This is a [textual](https://textual.textualize.io/) user interface for the for OpenAI's [Assistant](https://platform.openai.com/docs/assistants/overview) API.
https://github.com/dalssoft/textual-assistant/assets/209287/71d28cd9-1dd0-445d-a644-d62b255fe192
# How to use
## Setup
```bash
pyenv install 3.12.0 # install python version
pyenv local 3.12.0 # set python version
python -m venv venv # create virtual environment
source ./venv/bin/activate # activate virtual environment
pip3 install -r requirements.txt # install dependencies
```
## Run
```bash
export OPENAI_API_KEY=sk-.... # set openai api key. alternatively, create a .env file with this key
python main.py
```
# Features
- [x] Textual User Interface
- [x] Assistant
- [ ] Create
- [x] Select
- [x] Details
- [x] Info
- [ ] Functions Details
- [x] Thread
- [x] Create
- [x] Select
- [x] Details
- [x] Message
- [x] List
- [ ] Annotations
- [ ] Attachments
- [x] Tools
- [x] Code Interpreter
- [x] Retrieve
- [ ] Function
- [x] Debug: Message / Runs / Steps
- [x] Log
- [x] Domain
- [x] Assistant
- [x] Create
- [x] Retrieve
- [x] Delete
- [x] List All
- [ ] Update
- [ ] Files
- [x] Thread
- [x] Create
- [x] Retrieve
- [x] Delete
- [x] List All
- [ ] Update
- [x] Retrieve Messages
- [x] Events
- [x] New Message
- [x] Persist
- [x] Local
- [ ] DB
- [x] Message
- [x] Create
- [x] Retrieve
- [ ] Update
- [ ] Files
- [x] Run
- [x] Create
- [x] Retrieve
- [x] Cancel
- [ ] List All
- [ ] Update
- [x] Polling
- [x] Events
- [x] Status Change
- [x] Step
- [x] Types
- [x] Message Creation
- [x] Tool Call
- [x] Retrieve
- [x] Polling
- [x] Events
- [x] New Step
- [x] Status Change
- [x] Tools
- [x] Code Interpreter
- [x] Retrieve
- [x] Function
- [ ] Handle Function Call