charla 1.0.0__tar.gz

charla-1.0.0/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+custom: https://www.paypal.me/rgmz
+github: yaph

charla-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: test-${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  run:
+    name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Hatch
+      run: pip install --upgrade hatch
+
+    - name: Run static analysis
+      run: hatch fmt --check
+
+    - name: Run tests
+      run: hatch test --python ${{ matrix.python-version }} --cover --randomize --parallel --retries 2 --retry-delay 1

charla-1.0.0/.gitignore

@@ -0,0 +1,165 @@
+chat-history/
+experimental/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

charla-1.0.0/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.

charla-1.0.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,51 @@
+# 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/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-1.0.0/charla/__init__.py

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

charla-1.0.0/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-1.0.0/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-1.0.0/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/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "charla"
+dynamic = ["version"]
+description = 'A terminal based chat application that works with local language models.'
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+keywords = ["chat-client", "cli", "llm", "chatbot", "ollama", "terminal"]
+authors = [
+  { name = "Ramiro Gómez", email = "code@ramiro.org" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "ollama",
+  "platformdirs",
+  "prompt_toolkit"
+]
+
+[project.scripts]
+charla = "charla.cli:main"
+
+[project.urls]
+Documentation = "https://github.com/yaph/charla#readme"
+Issues = "https://github.com/yaph/charla/issues"
+Source = "https://github.com/yaph/charla"
+
+[tool.hatch.version]
+path = "charla/__about__.py"
+
+[tool.hatch.envs.dev]
+extra-dependencies = ["flake8", "ipdb", "mypy>=1.0.0"]
+
+[tool.hatch.envs.dev.scripts]
+type_check = "mypy --install-types --non-interactive {args:charla tests}"
+
+[tool.hatch.envs.pub.scripts]
+release = [
+  "hatch test",
+  "hatch build --clean",
+  "hatch publish -u __token__",
+  "git tag -a $(hatch version) -m \"Create version $(hatch version)\"",
+  "git push --tags"
+]
+
+[tool.coverage.run]
+source_pkgs = ["charla", "tests"]
+branch = true
+parallel = true
+omit = [
+  "charla/__about__.py",
+]
+
+[tool.coverage.paths]
+charla = ["charla", "*/charla/charla"]
+tests = ["tests", "*/charla/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

charla-1.0.0/tests/__init__.py

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

charla-1.0.0/tests/test_chat.py

@@ -0,0 +1,12 @@
+from charla import chat
+
+
+def test_available_models():
+    models = chat.available_models()
+    assert len(models)
+    assert 'name' in models[0]
+
+
+def test_prompt_session():
+    session = chat.prompt_session('cache/prompt-history.txt')
+    assert session.message == chat.t_prompt

charla-1.0.0/todo.md

@@ -0,0 +1,4 @@
+# TODO
+
+* Load content from local and remote files.
+* Save default_model and other user settings in a config file