Metadata-Version: 2.4
Name: llamaball
Version: 1.1.1
Summary: Accessible document chat and RAG system powered by Ollama
Project-URL: Homepage, https://github.com/coolhand/llamaball
Project-URL: Documentation, https://llamaball.readthedocs.io
Project-URL: Repository, https://github.com/coolhand/llamaball
Project-URL: Issues, https://github.com/coolhand/llamaball/issues
Project-URL: Changelog, https://github.com/coolhand/llamaball/blob/main/CHANGELOG.md
Author-email: Luke Steuber <luke@lukesteuber.com>
Maintainer-email: Luke Steuber <luke@lukesteuber.com>
License: MIT License
        
        Copyright (c) 2025 Luke Steuber
        
        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 llamaballM, 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. 
License-File: LICENSE
Keywords: accessibility,ai,cli,document-chat,embeddings,local-ai,ollama,rag
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.8
Requires-Dist: beautifulsoup4>=4.9.0
Requires-Dist: markdown-it-py>=3.0.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: ollama>=0.1.7
Requires-Dist: openpyxl>=3.1.0
Requires-Dist: pdfminer-six>=202010
Requires-Dist: prompt-toolkit>=3.0.0
Requires-Dist: pypandoc>=1.7.0
Requires-Dist: python-docx>=1.1.2
Requires-Dist: rich>=13.0.0
Requires-Dist: tiktoken>=0.5.0
Requires-Dist: tqdm>=4.64.0
Requires-Dist: typer[all]>=0.9.0
Requires-Dist: xlrd>=2.0.1
Provides-Extra: all
Requires-Dist: black>=23.0; extra == 'all'
Requires-Dist: isort>=5.0; extra == 'all'
Requires-Dist: memory-profiler>=0.61.0; extra == 'all'
Requires-Dist: mkdocs-material>=9.0.0; extra == 'all'
Requires-Dist: mkdocs>=1.5.0; extra == 'all'
Requires-Dist: mkdocstrings[python]>=0.20.0; extra == 'all'
Requires-Dist: mypy>=1.0; extra == 'all'
Requires-Dist: openpyxl>=3.1.0; extra == 'all'
Requires-Dist: pdfminer-six>=20221105; extra == 'all'
Requires-Dist: pre-commit>=3.0; extra == 'all'
Requires-Dist: psutil>=5.9.0; extra == 'all'
Requires-Dist: pytest-cov>=4.0; extra == 'all'
Requires-Dist: pytest>=7.0; extra == 'all'
Requires-Dist: python-docx>=0.8.11; extra == 'all'
Requires-Dist: xlrd>=2.0.1; extra == 'all'
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == 'dev'
Requires-Dist: isort>=5.0; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pre-commit>=3.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.20.0; extra == 'docs'
Provides-Extra: files
Requires-Dist: openpyxl>=3.1.0; extra == 'files'
Requires-Dist: pdfminer-six>=20221105; extra == 'files'
Requires-Dist: python-docx>=0.8.11; extra == 'files'
Requires-Dist: xlrd>=2.0.1; extra == 'files'
Provides-Extra: performance
Requires-Dist: memory-profiler>=0.61.0; extra == 'performance'
Requires-Dist: psutil>=5.9.0; extra == 'performance'
Description-Content-Type: text/markdown

# 🦙 Llamaball

**High-performance document chat and RAG system powered by Ollama**

[![PyPI version](https://badge.fury.io/py/llamaball.svg)](https://badge.fury.io/py/llamaball)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A local-first toolkit for document ingestion, embedding generation, and conversational AI interactions. Built for privacy and performance.

## ✨ Key Features

- **🏠 100% Local**: No external API calls, complete privacy
- **🚀 High Performance**: Multi-threaded processing with intelligent caching
- **📚 Smart Parsing**: 80+ file types with advanced chunking
- **💬 Interactive Chat**: Context-aware conversations with your documents
- **🔧 Developer-Friendly**: Full Python API with async support

## 🚀 Quick Start

### Installation & Setup

```bash
# Install
pip install llamaball

# Install Ollama (required)
# Visit https://ollama.ai/ for installation

# Pull recommended models
ollama pull llama3.2:1b          # Fast chat model
ollama pull nomic-embed-text     # Required for embeddings
```

### Basic Usage

```bash
# Ingest documents
llamaball ingest .

# Start chatting
llamaball chat

# Get help
llamaball --help
```

## 📋 CLI Commands

### Document Processing
```bash
llamaball ingest ./docs --recursive --chunk-size 1000
llamaball list --search "python" --type py
llamaball stats
```

### Chat Features
```bash
llamaball chat --model llama3.2:3b --temperature 0.7
```

### In-Chat Commands
- `/models` - List available models
- `/model <name>` - Switch models
- `/temp <0.0-2.0>` - Adjust creativity
- `/help` - Show all commands

## 🐍 Python API

```python
from llamaball import core

# Ingest documents
core.ingest_files("./docs", recursive=True)

# Search
results = core.search_embeddings("machine learning", top_k=5)

# Chat
response = core.chat("Explain neural networks", enable_context=True)
```

## ⚙️ Configuration

### Environment Variables
- `CHAT_MODEL`: Default chat model (default: `llama3.2:1b`)
- `EMBEDDING_MODEL`: Embedding model (default: `nomic-embed-text`)
- `OLLAMA_ENDPOINT`: Ollama server (default: `http://localhost:11434`)

### Supported File Types
- **Text**: `.txt`, `.md`, `.rst`, `.tex`
- **Code**: `.py`, `.js`, `.ts`, `.html`, `.css`, `.json`, `.yaml`
- **Documents**: `.pdf`, `.docx`, `.csv`, `.xlsx`
- **Notebooks**: `.ipynb`

## 🔧 Development

```bash
# Clone and install
git clone https://github.com/coolhand/llamaball.git
cd llamaball
pip install -e .[dev]

# Run tests
pytest

# Format code
black llamaball/ tests/
```

## 📁 Project Structure

```
llamaball/
├── llamaball/          # Main package
│   ├── cli.py          # CLI interface
│   ├── core.py         # Core functionality
│   └── utils.py        # Utilities
├── tests/              # Test suite
├── docs/               # Documentation
└── README.md           # This file
```

## 📝 License

MIT License - see [LICENSE](LICENSE) file.

**Created by Luke Steuber** - [lukesteuber.com](https://lukesteuber.com)
- Contact: luke@lukesteuber.com
- GitHub: [lukeslp](https://github.com/lukeslp)
- Support: [Tip Jar](https://usefulai.lemonsqueezy.com/buy/bf6ce1bd-85f5-4a09-ba10-191a670f74af)

---

*For detailed documentation, advanced features, and comprehensive examples, see the [full documentation](docs/).*
