parllama 0.2.0__tar.gz

parllama-0.2.0/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.1
+Name: parllama
+Version: 0.2.0
+Summary: Terminal UI for Ollama
+Home-page: https://github.com/paulrobello/parllama
+Author: Paul Robello
+Author-email: probello@gmail.com
+Maintainer: Paul Robello
+Maintainer-email: probello@gmail.com
+License: License :: OSI Approved :: MIT License
+Project-URL: Documentation, https://github.com/paulrobello/parllama/blob/main/README.md
+Project-URL: Source, https://github.com/paulrobello/parllama
+Project-URL: Issues, https://github.com/paulrobello/parllama/issues
+Project-URL: Wiki, https://github.com/paulrobello/parllama/wiki
+Keywords: ollama,ai,terminal,tui
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Classifier: Development Status :: 4 - Beta
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Terminals
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3
+Requires-Dist: requests
+Requires-Dist: simplejson
+Requires-Dist: attrs
+Requires-Dist: certifi
+Requires-Dist: requests-file
+Requires-Dist: textual[syntax]>=0.69.0
+Requires-Dist: asyncio
+Requires-Dist: humanize
+Requires-Dist: argparse
+Requires-Dist: pyperclip
+Requires-Dist: rich
+Requires-Dist: python-dotenv
+Requires-Dist: pydantic
+Requires-Dist: ollama
+Requires-Dist: bs4
+Requires-Dist: docker
+
+# PAR LLAMA
+
+## About
+PAR LLAMA is a TUI application designed for easy management and use of Ollama based LLMs.
+The application was built with [Textual](https://textual.textualize.io/) and [Rich](https://github.com/Textualize/rich?tab=readme-ov-file)
+
+### Screenshots
+Supports Dark and Light mode as well as custom themes.
+
+![Local Models Dark](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/local_models_dark_1.png)
+    
+![Model View Dark](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/models_view_dark_1.png)
+
+![Site Models Dark](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/site_models_dark_1.png)
+
+![Local Models Light](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/local_models_light_1.png)
+
+## Prerequisites for running
+* Install and run [Ollama](https://ollama.com/download) 
+* Install Python 3.11 or newer
+
+## Prerequisites for dev
+* Install pipenv
+* Install GNU Compatible Make command
+
+## Prerequisites for model quantization
+If you want to be able to quantize custom models, download the following tool from the releases area: 
+[HuggingFaceModelDownloader](https://github.com/bodaay/HuggingFaceModelDownloader)
+
+Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+
+Pull the docker image ollama/quantize
+```bash
+docker pull ollama/quantize
+```
+
+## Installing from mypi using pip
+Create a virtual environment and install using pip
+```bash
+mkdir parllama
+cd parllama
+python -m venv venv
+source venv/Scripts/activate
+pip install parllama
+```
+
+## Installing from mypi using pipx
+```bash
+pipx install parllama
+```
+
+## Installing for dev mode
+Clone the repo and run the following from the root of the repo:
+```bash
+make first-setup
+```
+
+
+## Command line arguments
+```
+usage: PAR LLAMA TUI [-h] [-v] [-d DATA_DIR] [-t THEME_NAME] [-m {dark,light}] [--restore-defaults] [--clear-cache] [--no-save]
+
+PAR LLAMA TUI -- Ollama TUI.
+
+options:
+  -h, --help            show this help message and exit
+  -v, --version         Show version information.
+  -d DATA_DIR, --data-dir DATA_DIR
+                        Data Directory. Defaults to ~/.parllama
+  -t THEME_NAME, --theme-name THEME_NAME
+                        Theme name. Defaults to par
+  -m {dark,light}, --theme-mode {dark,light}
+                        Dark / Light mode. Defaults to dark
+  --restore-defaults    Restore default settings and theme
+  --clear-cache         Clear cached data
+  --no-save             Prevent saving settings for this session.
+  --clear-cache         Clear cached data
+```
+
+## Environment Variables
+* PARLLAMA_DATA_DIR - Used to set --data-dir
+* PARLLAMA_THEME_NAME - Used to set --theme-name
+* PARLLAMA_THEME_MODE - Used to set --theme-mode
+
+
+## Running Par Llama
+
+### with pipx installation
+From anywhere:
+```bash
+parllama
+```
+
+### with pip installation
+From parent folder of venv
+```bash
+source venv/Scripts/activate
+parllama
+```
+
+### Dev mode
+From repo root:
+```bash
+make dev
+```
+
+## Themes
+Themes are json files stored in the themes folder in the data directory which defaults to **~/.parllama/themes**  
+
+The default theme is "par" so can be located in **~/.parllama/themes/par.json**  
+
+Themes have a dark and light mode are in the following format:  
+```json
+{
+  "dark": {
+    "primary": "#e49500",
+    "secondary": "#6e4800",
+    "warning": "#ffa62b",
+    "error": "#ba3c5b",
+    "success": "#4EBF71",
+    "accent": "#6e4800",
+    "panel": "#111",
+    "surface":"#1e1e1e",
+    "background":"#121212",
+    "dark": true
+  },
+  "light": {
+    "primary": "#004578",
+    "secondary": "#ffa62b",
+    "warning": "#ffa62b",
+    "error": "#ba3c5b",
+    "success": "#4EBF71",
+    "accent": "#0178D4",
+    "background":"#efefef",
+    "surface":"#f5f5f5",
+    "dark": false
+  }
+}
+```
+
+You must specify at least one of light or dark for the theme to be usable.  
+
+Theme can be changed via command line with the ```--theme-name``` option.
+
+
+# Changelog
+
+### 0.2.0
+Initial Release

parllama-0.2.0/README.md

@@ -0,0 +1,149 @@
+# PAR LLAMA
+
+## About
+PAR LLAMA is a TUI application designed for easy management and use of Ollama based LLMs.
+The application was built with [Textual](https://textual.textualize.io/) and [Rich](https://github.com/Textualize/rich?tab=readme-ov-file)
+
+### Screenshots
+Supports Dark and Light mode as well as custom themes.
+
+![Local Models Dark](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/local_models_dark_1.png)
+    
+![Model View Dark](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/models_view_dark_1.png)
+
+![Site Models Dark](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/site_models_dark_1.png)
+
+![Local Models Light](https://raw.githubusercontent.com/paulrobello/parllama/main/docs/local_models_light_1.png)
+
+## Prerequisites for running
+* Install and run [Ollama](https://ollama.com/download) 
+* Install Python 3.11 or newer
+
+## Prerequisites for dev
+* Install pipenv
+* Install GNU Compatible Make command
+
+## Prerequisites for model quantization
+If you want to be able to quantize custom models, download the following tool from the releases area: 
+[HuggingFaceModelDownloader](https://github.com/bodaay/HuggingFaceModelDownloader)
+
+Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
+
+Pull the docker image ollama/quantize
+```bash
+docker pull ollama/quantize
+```
+
+## Installing from mypi using pip
+Create a virtual environment and install using pip
+```bash
+mkdir parllama
+cd parllama
+python -m venv venv
+source venv/Scripts/activate
+pip install parllama
+```
+
+## Installing from mypi using pipx
+```bash
+pipx install parllama
+```
+
+## Installing for dev mode
+Clone the repo and run the following from the root of the repo:
+```bash
+make first-setup
+```
+
+
+## Command line arguments
+```
+usage: PAR LLAMA TUI [-h] [-v] [-d DATA_DIR] [-t THEME_NAME] [-m {dark,light}] [--restore-defaults] [--clear-cache] [--no-save]
+
+PAR LLAMA TUI -- Ollama TUI.
+
+options:
+  -h, --help            show this help message and exit
+  -v, --version         Show version information.
+  -d DATA_DIR, --data-dir DATA_DIR
+                        Data Directory. Defaults to ~/.parllama
+  -t THEME_NAME, --theme-name THEME_NAME
+                        Theme name. Defaults to par
+  -m {dark,light}, --theme-mode {dark,light}
+                        Dark / Light mode. Defaults to dark
+  --restore-defaults    Restore default settings and theme
+  --clear-cache         Clear cached data
+  --no-save             Prevent saving settings for this session.
+  --clear-cache         Clear cached data
+```
+
+## Environment Variables
+* PARLLAMA_DATA_DIR - Used to set --data-dir
+* PARLLAMA_THEME_NAME - Used to set --theme-name
+* PARLLAMA_THEME_MODE - Used to set --theme-mode
+
+
+## Running Par Llama
+
+### with pipx installation
+From anywhere:
+```bash
+parllama
+```
+
+### with pip installation
+From parent folder of venv
+```bash
+source venv/Scripts/activate
+parllama
+```
+
+### Dev mode
+From repo root:
+```bash
+make dev
+```
+
+## Themes
+Themes are json files stored in the themes folder in the data directory which defaults to **~/.parllama/themes**  
+
+The default theme is "par" so can be located in **~/.parllama/themes/par.json**  
+
+Themes have a dark and light mode are in the following format:  
+```json
+{
+  "dark": {
+    "primary": "#e49500",
+    "secondary": "#6e4800",
+    "warning": "#ffa62b",
+    "error": "#ba3c5b",
+    "success": "#4EBF71",
+    "accent": "#6e4800",
+    "panel": "#111",
+    "surface":"#1e1e1e",
+    "background":"#121212",
+    "dark": true
+  },
+  "light": {
+    "primary": "#004578",
+    "secondary": "#ffa62b",
+    "warning": "#ffa62b",
+    "error": "#ba3c5b",
+    "success": "#4EBF71",
+    "accent": "#0178D4",
+    "background":"#efefef",
+    "surface":"#f5f5f5",
+    "dark": false
+  }
+}
+```
+
+You must specify at least one of light or dark for the theme to be usable.  
+
+Theme can be changed via command line with the ```--theme-name``` option.
+
+
+# Changelog
+
+### 0.2.0
+Initial Release

parllama-0.2.0/parllama/__init__.py

@@ -0,0 +1,22 @@
+"""PAR LLAMA TUI - A terminal user interface for Ollama."""
+
+__author__ = "Paul Robello"
+__copyright__ = "Copyright 2024, Paul Robello"
+__credits__ = ["Paul Robello"]
+__maintainer__ = "Paul Robello"
+__email__ = "probello@gmail.com"
+__version__ = "0.2.0"
+__licence__ = "MIT"
+__application_title__ = "PAR LLAMA"
+
+
+__all__: list[str] = [
+    "__author__",
+    "__copyright__",
+    "__credits__",
+    "__maintainer__",
+    "__email__",
+    "__version__",
+    "__licence__",
+    "__application_title__",
+]

parllama-0.2.0/parllama/__main__.py

@@ -0,0 +1,25 @@
+"""The main entry point for the application."""
+
+from __future__ import annotations
+
+import os
+
+from parllama.app import ParLlamaApp
+from parllama.models.settings_data import settings
+
+if os.environ.get("DEBUG"):
+    import pydevd_pycharm  # type: ignore
+
+    pydevd_pycharm.settrace(
+        "localhost", port=12345, suspend=False, patch_multiprocessing=True
+    )
+
+
+def run() -> None:
+    """Run the application."""
+    print(f"Settings folder {settings.data_dir}")
+    ParLlamaApp().run()
+
+
+if __name__ == "__main__":
+    run()