A tiny bot built for simplicity
Project description
Pico Bot
A lightweight terminal-based AI assistant for simple, interactive chat.
Features
- Terminal chat interface
- OpenAI integration via LangChain
- Conversation memory
- Safe local file access
Screenshot
Installation
Requirements
- Python 3.12 (tested)
- An OpenAI API key
For Users
Install Pico Bot from PyPI:
pip install picobot
For Development
Clone the repository and install in editable mode:
git clone git@github.com:ngpeijiun/picobot.git
cd picobot
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e .
Configuration
Set your OpenAI API key in your environment:
export OPENAI_API_KEY="your_api_key"
On Windows PowerShell:
$env:OPENAI_API_KEY="your_api_key"
Usage
picobot
Type exit or quit to leave the session.
Safety
The read_file tool only allows access to files inside the project root directory. This helps prevent path traversal outside the repository.
Roadmap
- Add more tools
- Add tests
- Improve configuration and error handling
License
MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file picobot-0.1.1.1.tar.gz.
File metadata
- Download URL: picobot-0.1.1.1.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
014e4e1a79e3fb02542effb74af14fe05d5f9da234c08fa6243663d317fce596
|
|
| MD5 |
746a8b9b2ac2b3b6ac26a7e63bed05f6
|
|
| BLAKE2b-256 |
928ae7cba1bddd94eebee3ce75a4f0bab0a5c0c79ff6b703b9a6e1bc6c00a954
|
File details
Details for the file picobot-0.1.1.1-py3-none-any.whl.
File metadata
- Download URL: picobot-0.1.1.1-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b604903a533d08bc729be6d9671b07b24d932e704ace7aa3eb2c9d76d123764
|
|
| MD5 |
05daa634c8238cca3e3aef0efa6c8d0b
|
|
| BLAKE2b-256 |
89e771805ac52a90e666e3e9deef8cd450b776b1facefb81214d8cfaf0ba7337
|
