Metadata-Version: 2.1
Name: sprite-ai
Version: 1.2.1
Summary: Sprite AI is an AI companion for your desktop
Author: Caio D
Author-email: caiobd@protonmail.com
Requires-Python: >=3.8.1,<3.13
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: PyQt5 (>=5.15.2,<6.0.0)
Requires-Dist: dbus-python (>=1.3.2,<2.0.0)
Requires-Dist: langchain (>=0.0.327,<0.0.328)
Requires-Dist: llama-cpp-python (>=0.2.12,<0.3.0)
Requires-Dist: loguru (>=0.7.2,<0.8.0)
Requires-Dist: platformdirs (>=4.0.0,<5.0.0)
Requires-Dist: plyer (>=2.1.0,<3.0.0)
Requires-Dist: progressbar2 (>=4.2.0,<5.0.0)
Requires-Dist: pydantic (>=2.4.2,<3.0.0)
Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
Requires-Dist: python-rofi (>=1.0.1,<2.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# Sprite AI


## Description
Sprite AI is an AI companion for your desktop, through LLM technology a sprite can generate text, dialog and even computer code


## Minimum requirements

Description |  Value
------------|------------------------------
OS          |   MacOS, Linux [Tested only on Linux]
CPU         |   Any
GPU         |   Any [Optionall]
RAM         |   >= 8GB
Storage     |   6GB


## Dependencies
- [Python](https://www.python.org/) >= 3.8
- [Rofi](https://github.com/davatorium/rofi)
- pipx [Optional]


## Installation
1. [Install Python](https://wiki.python.org/moin/BeginnersGuide/Download) >= 3.8
1. [Install Rofi](https://github.com/davatorium/rofi/blob/next/INSTALL.md)
1. [Install pipx](https://pypa.github.io/pipx/#install-pipx) [Optional dependency]
1. Install Sprite AI  
    a. Use pip [default]
    > pip install --user sprite-ai

    b. Use pipx [altenative]
    > pipx install sprite-ai


## Usage

### Starting Sprite AI
In a terminal type the following command
> sprite-ai

### Interacting with a sprite
You can interact with a sprite by clicking on it, this will open the interaction menu

### Interaction menu
In this menu you can either select a command to execute it or a previous message from chat to copy the message to your clipboard

#### Available commands

Command     | Description
------------|-----------------------------------------------------------------
new message | Opens a textbox that allows you to send a message to the sprite
exit        | Closes Sprite AI

