charla 1.0.0__py3-none-any.whl

charla/__about__.py

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2024-present Ramiro Gómez <code@ramiro.org>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "1.0.0"
+__name__ = "charla"

charla/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Ramiro Gómez <code@ramiro.org>
+#
+# SPDX-License-Identifier: MIT

charla/chat.py

@@ -0,0 +1,74 @@
+from datetime import datetime
+from operator import itemgetter
+from pathlib import Path
+from typing import Any
+
+from prompt_toolkit import PromptSession
+from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
+from prompt_toolkit.history import FileHistory
+from prompt_toolkit.key_binding import KeyBindings
+
+import re
+
+import ollama
+
+
+# UI text
+t_prompt = 'PROMPT: '
+t_prompt_ml = 'PROMPT \N{LATIN SUBSCRIPT SMALL LETTER M}\N{LATIN SUBSCRIPT SMALL LETTER L}: '
+t_response = 'RESPONSE:'
+t_help = '''
+Press CTRL-C or CTRL-D to exit chat.
+Press ALT+M to switch between single and multi line mode.
+Press ALT+RETURN to send prompt in multi line mode.
+Press ↑ and ↓ to navigate previously entered prompts.
+Press → to complete an auto suggested prompt.
+'''
+
+def available_models() -> None | list[str]:
+    """Return available models sorted by size."""
+
+    if model_list := ollama.list()['models']:
+        return [m for m in sorted(model_list, key=itemgetter('size'))]
+
+
+def generate(model: str, prompt: str, context: list, output: list) -> str | Any:
+    stream = ollama.generate(model=model, prompt=prompt, context=context, stream=True)
+
+    text = ''
+    for chunk in stream:
+        if not chunk['done']:
+            text += chunk['response']
+            print(chunk['response'], end='', flush=True)
+
+    output.append(f'{t_response}\n\n{text}\n')
+    return chunk['context']
+
+
+def prompt_session(history: Path) -> PromptSession:
+    session = PromptSession(message=t_prompt,
+                            history=FileHistory(history),
+                            auto_suggest=AutoSuggestFromHistory())
+
+    print(t_help)
+
+    bindings = KeyBindings()
+
+    @bindings.add('escape', 'm')
+    def switch_multiline(event):
+        session.multiline = not session.multiline
+        session.message = t_prompt if session.multiline is False else t_prompt_ml
+
+    session.key_bindings = bindings
+
+    return session
+
+
+def save(chats_path: Path, output: list[str], model_name: str) -> None:
+    if len(output) > 1:
+        now = datetime.strftime(datetime.now(), '%Y-%m-%d-%H-%M-%S')
+        slug = re.sub(r'\W', '-', model_name)
+        file = chats_path / f'{now}-{slug}.md'
+
+        print(f'Saving chat in: {file}')
+        file.write_text('\n'.join(output))

charla/cli.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+import argparse
+import sys
+
+from pathlib import Path
+
+from prompt_toolkit import HTML, print_formatted_text as print_fmt
+
+from charla import chat, config
+
+
+def main():
+    if (models := chat.available_models()) is None:
+        sys.exit('No language models available.')
+    model_names = [m['name'] for m in models]
+
+    parser = argparse.ArgumentParser(description='Chat with local language models.')
+    parser.add_argument('--model', '-m',
+                        choices=model_names,
+                        help='Language model to chat with.')
+    argv = parser.parse_args()
+
+    # Determine model
+    if (model := config.setting('model', argv.model)) == '':
+        model = model_names[0]
+
+    context = [] # Store conversation history to make the model context aware
+    output = [f'# Chat with: {model}\n']  # List to store output text
+
+    history = Path(config.setting('prompt_history'))
+    history.parent.mkdir(exist_ok=True, parents=True)
+    session = chat.prompt_session(history)
+
+    print_fmt('Chat with:', HTML(f'<ansigreen>{model}</ansigreen>'), '\n')
+
+    while True:
+        try:
+            user_input = session.prompt()
+            if not user_input:
+                continue
+
+            output.append(f'{chat.t_prompt}{user_input}\n')
+            print(f'\n{chat.t_response}\n')
+            context = chat.generate(model, user_input, context, output)
+            print('\n')
+        # Exit program on CTRL-C and CTRL-D
+        except (KeyboardInterrupt, EOFError):
+            break
+
+    chats_path = Path(config.setting('chats_path'))
+    chats_path.mkdir(exist_ok=True, parents=True)
+    chat.save(chats_path, output, model)
+
+    print_fmt(HTML('<b>Exiting program.</b>'))
+    sys.exit()
+
+
+if __name__ == '__main__':
+    main()

charla/config.py

@@ -0,0 +1,17 @@
+from platformdirs import user_cache_dir, user_documents_dir
+
+from charla import __about__
+
+
+name = __about__.__name__
+
+default_settings = {
+    'model': '',
+    'chats_path': user_documents_dir() + f'/{name}/chats',
+    'prompt_history': user_cache_dir(appname=name) + '/prompt-history.txt'
+}
+
+
+def setting(key: str, value: str = None) -> str:
+    return value if value else default_settings.get(key)
+

charla-1.0.0.dist-info/METADATA

@@ -0,0 +1,75 @@
+Metadata-Version: 2.3
+Name: charla
+Version: 1.0.0
+Summary: A terminal based chat application that works with local language models.
+Project-URL: Documentation, https://github.com/yaph/charla#readme
+Project-URL: Issues, https://github.com/yaph/charla/issues
+Project-URL: Source, https://github.com/yaph/charla
+Author-email: Ramiro Gómez <code@ramiro.org>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: chat-client,chatbot,cli,llm,ollama,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: ollama
+Requires-Dist: platformdirs
+Requires-Dist: prompt-toolkit
+Description-Content-Type: text/markdown
+
+# Charla: Terminal-Based Chat Application with Ollama Backend Integration
+
+[![PyPI - Version](https://img.shields.io/pypi/v/charla.svg)](https://pypi.org/project/charla)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/charla.svg)](https://pypi.org/project/charla)
+
+**Charla** is a terminal based chat application that integrates with [Ollama](https://ollama.com/), a backend designed to serve language models. To use Charla, ensure that the `ollama` server is running and at least one language model is installed.
+
+## Installation
+
+Install Charla using `pipx`:
+
+```console
+pipx install charla
+```
+
+## Usage
+
+Launch the chat console by typing `charla` in your terminal, or view all available command line options with `charla -h`.
+
+## Features
+
+* Terminal-based chat system that supports context aware conversations using local language models.
+* Chat sessions are saved as markdown files in the user's documents directory when ending a chat.
+* Prompt history is saved and previously entered prompts are auto-suggested.
+* Mode switching between single-line and multi-line input without interruption to your chat session.
+
+## Development
+
+Run the command-line interface directly from the project source without installing the package:
+
+```console
+python -m charla.cli
+```
+
+### ollama API
+
+Installed models:
+
+```console
+curl http://localhost:11434/api/tags
+```
+
+Model info:
+
+```console
+curl http://localhost:11434/api/show -d '{"name": "phi3"}'
+```
+
+## License
+
+Charla is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

charla-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+charla/__about__.py,sha256=Blg6iKaeiQFme-iczvLMNAHKz6B_cwZ5xlz3GGaq-aA,146
+charla/__init__.py,sha256=Hi18ekz_kKsIjEqVYaHHs-MVJlgZZ0iyoNBNbrYKseU,104
+charla/chat.py,sha256=g89kxW_ORiOn64wN3-DmVCOuvt7OoTKOqtVuRnbikJs,2261
+charla/cli.py,sha256=W-wpe9uICm2_2M_cr0gLap1w43IpFM54UUY_2Bz1GX0,1777
+charla/config.py,sha256=1vKo-piBOqmpi7gOV3Hxdy4LbK6yZFRcPBpZ-A-IJFE,402
+charla-1.0.0.dist-info/METADATA,sha256=N90mp3D3A3EyeWCH3X5nAL3syr91z-HtCQMFRKq90G8,2556
+charla-1.0.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+charla-1.0.0.dist-info/entry_points.txt,sha256=tiU6hih4woARmY1PQ__iV2zJMXUCASiZv3UUZyjzhd0,43
+charla-1.0.0.dist-info/licenses/LICENSE.txt,sha256=xHAsOfDjwvLq-EgPUtcbXVleLyzpP-CoWJtpff97lcE,1096
+charla-1.0.0.dist-info/RECORD,,

charla-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

charla-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+charla = charla.cli:main

charla-1.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Ramiro Gómez <code@ramiro.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.