| Name | ollamate JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Ollamate is a simple AI assistant for local LLMs hosted on your machine using Ollama. it will support some custom functions and a RAG system. |
| upload_time | 2025-02-10 02:59:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
gui
ai
assistant
bot
chat
llama
llm
ollama
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
ollama
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src='img/screenshot.png'>
# <img src='img/og.png'> Ollamate
**Ollamate** (A playful combination of "Ollama" and "mate" implying a helpful companion ) is an **AI assistant**, using [Ollama](https://ollama.com) to run your favorite LLMs locally as your assistant.
It support an user-friendly GUI, making interaction with Ollama easier and more gentle than before. Additionally in future, it will support a simple RAG system and multiple different tools making daily routine tasks a no-brainer.
<small>"This project is licensed under the terms of the MIT license."</small>
<hr>
### 💻 How To Use It
First, install the app using:
```bash
pip install ollamate
```
Then, before running the following command, make sure that you are running Ollama on your system and pulled your desired LLM model from [here](https://ollama.com/library).
⚠️ Notice that you may encounter **errors** such as:
```
ImportError: No module named ‘Tkinter’
```
or
```
ModuleNotFoundError: No module named 'tkinter' in Python
```
which are explained in the next section.
To run the app:
```bash
ollamate
```
Or simply run:
```bash
om
```
<hr>
### Q/A
#### I'm getting ImportError or ModuleNotFoundError errors.
The errors:
```
ImportError: No module named 'tkinter'
```
or
```
ModuleNotFoundError: No module named 'tkinter' in Python
```
These happen due to lack of the Tk library on your machine:
For **Ubuntu**:
```
sudo apt-get install python3-tk
```
For **Fedora**:
```
sudo dnf install python3-tkinter
```
For **macOS**:
```
brew install python-tk
```
#### How can I contribute in this project?
- **Fork** the project
- Make your **changes**
- Build a **pull-request** on the our main project's repository
Raw data
{
"_id": null,
"home_page": null,
"name": "ollamate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "GUI, ai, assistant, bot, chat, llama, llm, ollama",
"author": null,
"author_email": "Iraj Jelodari <Iraj.Jelo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8f/f8/b9348c19374a62fdb241d26bab973f61025fc600a6461ef79ee16322a575/ollamate-0.0.1.tar.gz",
"platform": null,
"description": "<img src='img/screenshot.png'> \n\n# <img src='img/og.png'> Ollamate\n\n**Ollamate** (A playful combination of \"Ollama\" and \"mate\" implying a helpful companion ) is an **AI assistant**, using [Ollama](https://ollama.com) to run your favorite LLMs locally as your assistant.\n\nIt support an user-friendly GUI, making interaction with Ollama easier and more gentle than before. Additionally in future, it will support a simple RAG system and multiple different tools making daily routine tasks a no-brainer. \n\n<small>\"This project is licensed under the terms of the MIT license.\"</small>\n\n<hr>\n\n### \ud83d\udcbb How To Use It\n\nFirst, install the app using:\n\n```bash\npip install ollamate\n```\n\nThen, before running the following command, make sure that you are running Ollama on your system and pulled your desired LLM model from [here](https://ollama.com/library).\n\n\u26a0\ufe0f Notice that you may encounter **errors** such as:\n ```\n ImportError: No module named \u2018Tkinter\u2019\n ```\n or \n ```\n ModuleNotFoundError: No module named 'tkinter' in Python\n ```\nwhich are explained in the next section.\n\nTo run the app:\n\n```bash\nollamate\n```\nOr simply run:\n\n```bash\nom\n```\n\n<hr>\n\n### Q/A\n\n#### I'm getting ImportError or ModuleNotFoundError errors.\n\nThe errors:\n```\nImportError: No module named 'tkinter'\n```\nor \n```\nModuleNotFoundError: No module named 'tkinter' in Python\n```\n\nThese happen due to lack of the Tk library on your machine: \n\nFor **Ubuntu**:\n\n```\nsudo apt-get install python3-tk\n```\n\nFor **Fedora**:\n\n```\nsudo dnf install python3-tkinter\n```\n\nFor **macOS**:\n\n```\nbrew install python-tk\n```\n\n#### How can I contribute in this project?\n\n- **Fork** the project\n- Make your **changes**\n- Build a **pull-request** on the our main project's repository",
"bugtrack_url": null,
"license": null,
"summary": "Ollamate is a simple AI assistant for local LLMs hosted on your machine using Ollama. it will support some custom functions and a RAG system.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/iraj-jelo/ollamate",
"Issues": "https://github.com/iraj-jelo/ollamate/issues"
},
"split_keywords": [
"gui",
" ai",
" assistant",
" bot",
" chat",
" llama",
" llm",
" ollama"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fc159c6876bc856a9f9b377069cc0e5b9e59fc1ad79324f6e0ab9b0e5d583156",
"md5": "01e75c3a231776e1b6c21b83c4790de1",
"sha256": "940b435325005bb5111f4fcbc35f515fdf8d6148d67341018948f014978c26dc"
},
"downloads": -1,
"filename": "ollamate-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01e75c3a231776e1b6c21b83c4790de1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 15101,
"upload_time": "2025-02-10T02:59:32",
"upload_time_iso_8601": "2025-02-10T02:59:32.171712Z",
"url": "https://files.pythonhosted.org/packages/fc/15/9c6876bc856a9f9b377069cc0e5b9e59fc1ad79324f6e0ab9b0e5d583156/ollamate-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8ff8b9348c19374a62fdb241d26bab973f61025fc600a6461ef79ee16322a575",
"md5": "6a349e43a4d70b287145ec52eeaf5b14",
"sha256": "21ee02de2dcbedcbbd7d313ae072934fbba29c11e1c571381f3665bd7fa42a1d"
},
"downloads": -1,
"filename": "ollamate-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "6a349e43a4d70b287145ec52eeaf5b14",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 12420,
"upload_time": "2025-02-10T02:59:35",
"upload_time_iso_8601": "2025-02-10T02:59:35.319037Z",
"url": "https://files.pythonhosted.org/packages/8f/f8/b9348c19374a62fdb241d26bab973f61025fc600a6461ef79ee16322a575/ollamate-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-10 02:59:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iraj-jelo",
"github_project": "ollamate",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "ollama",
"specs": [
[
">=",
"0.5.0"
]
]
}
],
"lcname": "ollamate"
}
