Metadata-Version: 2.4
Name: arxiv-paper-digest
Version: 0.1.0
Summary: A configurable daily ArXiv digest agent — filter and summarise papers in any research area
Author: Ilona Eisenbraun
License: MIT License
        
        Copyright (c) 2026 Ilona Eisenbraun
        
        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.
        
Project-URL: Repository, https://github.com/ilonae/research-agent
Project-URL: Bug Tracker, https://github.com/ilonae/research-agent/issues
Keywords: arxiv,research,digest,llm,agent,langgraph,semantic-search
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: langgraph>=0.2.0
Requires-Dist: langchain-core>=0.3.0
Requires-Dist: langchain-ollama>=0.2.0
Requires-Dist: feedparser>=6.0.0
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: sentence-transformers>=3.0.0
Requires-Dist: numpy>=1.26
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-cov>=5.0; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Dynamic: license-file

# arxiv-paper-digest

A daily agent that monitors ArXiv for XAI and interpretability papers, filters by semantic similarity, summarises with a local LLM, and saves a Markdown digest. No external API keys required.

## How it works

```
1. ArXiv RSS 
2. filter_unseen (SQLite)
3. semantic filter (sentence-transformers)
4. summarise (Ollama) 
5. outputs/digests/YYYY-MM-DD.md
```

## Quickstart

```bash
# Requires Ollama running with the model pulled
ollama pull llama3.2:3b

pip install arxiv-xai-digest
arxiv-digest              # full run
arxiv-digest --dry-run    # skip LLM, test the rest of the pipeline
```

Or from source:

```bash
git clone https://github.com/ilonae/research-agent
cd research-agent
pip install -e ".[dev]"
```

## Configuration

Copy `.env.example` to `.env`. All variables are optional — defaults shown:

| Variable                       | Default                       |
| ------------------------------ | ----------------------------- |
| `AGENT_OLLAMA_MODEL`         | `llama3.2:3b`               |
| `AGENT_OLLAMA_URL`           | `http://localhost:11434`    |
| `AGENT_MAX_PER_FEED`         | `20`                        |
| `AGENT_ARXIV_CATEGORIES`     | `["cs.LG","cs.AI","cs.CV"]` |
| `AGENT_SIMILARITY_THRESHOLD` | `0.35`                      |
| `AGENT_EMBEDDING_MODEL`      | `all-MiniLM-L6-v2`          |
| `AGENT_ANCHORS`              | 8 XAI topic sentences         |

## Docker

```bash
docker compose up   # starts Ollama sidecar + agent
```

## Scheduled runs

`.github/workflows/daily-digest.yml` runs at 07:00 UTC and commits the digest back to the repo. Trigger manually from **Actions : Run workflow** to test.

## Querying the memory store

```bash
sqlite3 outputs/seen_papers.db \
  "SELECT title, first_seen FROM seen_papers
   WHERE first_seen >= date('now', '-7 days')
   ORDER BY first_seen DESC;"
```

## Development

```bash
pip install -e ".[dev]"
pytest && ruff check . && mypy agent/ tools/ config/
```

## License

MIT
