Metadata-Version: 2.4
Name: groundero
Version: 0.1.0
Summary: Visual grounding search for academic papers with Zotero integration
Project-URL: Homepage, https://github.com/rodrigodzf/groundero
Project-URL: Repository, https://github.com/rodrigodzf/groundero.git
Project-URL: Documentation, https://github.com/rodrigodzf/groundero#readme
Project-URL: Issues, https://github.com/rodrigodzf/groundero/issues
Author-email: Rodrigo Diaz <rodrigodzf@gmail.com>
License: MIT
License-File: LICENSE
Keywords: academic-search,ai,docling,langchain,pdf,research,visual-grounding,zotero
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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
Requires-Python: >=3.11
Requires-Dist: docling>=2.47.0
Requires-Dist: ipykernel>=6.30.1
Requires-Dist: langchain-core>=0.3.74
Requires-Dist: langchain-docling>=1.0.0
Requires-Dist: langchain-google-genai>=2.1.9
Requires-Dist: langchain-huggingface>=0.3.1
Requires-Dist: langchain-milvus>=0.2.1
Requires-Dist: langchain>=0.3.27
Requires-Dist: platformdirs>=4.3.8
Requires-Dist: python-dotenv>=1.1.1
Requires-Dist: pyzotero>=1.6.11
Requires-Dist: rich>=14.1.0
Requires-Dist: sentence-transformers>=5.1.0
Requires-Dist: sqlmodel>=0.0.24
Provides-Extra: dev
Requires-Dist: black>=23.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Requires-Dist: ty>=0.0.1a19; extra == 'dev'
Description-Content-Type: text/markdown

# Groundero

Visual grounding search for papers with Zotero integration and RAG-based question answering.

## Installation

### Prerequisites

- Python 3.11+
- [uv](https://docs.astral.sh/uv/) package manager
- Zotero desktop app (running locally)
- Google AI Studio API key

### Recommended

- [Better BibTeX](https://retorque.re/zotero-better-bibtex/) plugin for Zotero
- All items should have pinned citation keys (stored in the Extra field) for best results, auto-generated keys will be used as fallback for UI display.

### Setup

#### Install

```bash
uv tool install groundero
```

#### Development Install

```bash
uv sync
```

2. **Setup and build database**:

```bash
groundero
```

## Usage

### Commands

- `groundero` - Interactive query mode
- `groundero setup` - Initial setup and database build
- `groundero update [--limit N]` - Update database from Zotero
- `groundero query "question"` - Ask a single question
- `groundero list` - List indexed documents
- `groundero help` - Show help

### Examples

```bash
groundero update

# Ask questions about your papers
groundero query "Why are PINNs hard to train"

# Interactive mode for multiple queries
groundero
```

## Configuration

Environment is configured during `groundero setup` - no manual `.env` file needed.

### Zotero Local API Setup

**Required**: Groundero currently only works with local Zotero. Make sure the local API is enabled:

1. Open Zotero
2. Go to: **Settings** → **Advanced** → **Config Editor**
3. Set `extensions.zotero.httpServer.localAPI.enabled` to `true`
4. Restart Zotero

Without this setting, Groundero won't be able to connect to your local Zotero library.