Metadata-Version: 2.4
Name: local-ai-utils-core
Version: 0.2.5
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai
Requires-Dist: pyyaml
Requires-Dist: pytest
Requires-Dist: desktop_notifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license-file
Dynamic: requires-dist

# Local AI Utils - Core
Local AI Utils is a framework and set of local utilities for interacting with AI on your local computer. Conceptually each piece of local-ai-itls should be single-purpose and modular, such that end users can piece together their own AI-powered tool chains.

![Local AI Utils Demo](/docs/full_assist.gif)

## Quickstart
```
pip install local-ai-utils-core
```

## Configuration
Local AI Utils utilizes a YAML config file, which by default is stored at `~/.config/ai-utils.yml`. If you would like to store configs in a different location, you can set a custom path with the `AI_UTILS_CONFIG_PATH` environment variable.

The config file will need different values based on which AI providers you are using, and which plugins.

`~/.config/ai-utils.yml`
```
plugins:
    listen:
    assist:
        assistant: 'assistant_id'
        thread: 'thread_id'
keys:
    openai: "secret_key"
```

## Plugins
Local AI Utils finds almost all of its power in its plugin ecosystem. Plugins extend LAIU in ways that expand what both the AI can do, as well as what can be done on your local system.

Some plugins we'd recommend:
- [**assist**](https://github.com/local-ai-utils/assist) for prompting an AI assistant
- [**embedding**](https://github.com/local-ai-utils/embedding) for generating and searching embeddings. It includes a small local Lance DB.
- [**listen**](https://github.com/local-ai-utils/listen) for getting quick text-to-speech from your microphone
