Metadata-Version: 2.4
Name: litresearch
Version: 0.1.0
Summary: CLI tool for automated literature research workflows.
Project-URL: Homepage, https://github.com/spignotti/litresearch
Project-URL: Repository, https://github.com/spignotti/litresearch
Author-email: Silas Pignotti <pignottisilas@gmail.com>
License: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: httpx>=0.28.1
Requires-Dist: litellm>=1.82.0
Requires-Dist: pydantic-settings>=2.13.1
Requires-Dist: pydantic>=2.12.5
Requires-Dist: pypdf>=6.7.5
Requires-Dist: rich>=14.3.3
Requires-Dist: semanticscholar>=0.11.0
Requires-Dist: typer>=0.24.1
Description-Content-Type: text/markdown

# litresearch
[![CI](https://github.com/spignotti/litresearch/actions/workflows/ci.yml/badge.svg)](https://github.com/spignotti/litresearch/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/litresearch.svg)](https://pypi.org/project/litresearch/)

CLI tool that automates literature research from research questions to curated,
ranked, and exported paper sets with structured reports.

## Overview
- Automates discovery, screening, analysis, ranking, and export steps.
- Targets a CLI-first workflow with an importable Python API.
- Uses Semantic Scholar for paper metadata and LiteLLM for provider-agnostic LLM access.

## Planned Architecture
- Framework: Typer CLI with package modules under `src/litresearch/`
- Core dependencies: LiteLLM, Semantic Scholar client, Pydantic, httpx, pypdf, Rich
- Outputs: Markdown reports, bibliographic exports, downloaded PDFs, and JSON pipeline state

## Development
```bash
uv sync
uv run nox
uv run litresearch --help
```

## Status
This repository currently contains project scaffolding only. Product logic will be added in later planning and task steps.
