Metadata-Version: 2.4
Name: paperseek
Version: 1.0.0b2
Summary: PaperSeek Community backend
Author-email: PaperSeek Development Team <support@paperseek.app>
Maintainer-email: PaperSeek Development Team <support@paperseek.app>
License-Expression: Apache-2.0
Project-URL: Homepage, https://paperseek.app/
Project-URL: Repository, https://github.com/paperseek/paperseek
Project-URL: Issues, https://github.com/paperseek/paperseek/issues
Project-URL: Documentation, https://docs.paperseek.app/
Project-URL: Online-Demo, https://paperseek.app/
Keywords: literature-search,openalex,crossref,web-of-science,llm
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: THIRD_PARTY_NOTICES.md
Requires-Dist: alembic==1.19.1
Requires-Dist: cryptography==49.0.0
Requires-Dist: fastapi==0.141.1
Requires-Dist: httpx==0.28.1
Requires-Dist: pydantic==2.13.4
Requires-Dist: python-docx==1.2.0
Requires-Dist: sqlalchemy==2.0.51
Requires-Dist: uvicorn==0.52.1
Dynamic: license-file

# PaperSeek

**Open-source literature search, citation exploration, and abstract-based reviews.**

PaperSeek turns a research question into a reading list. It plans and refines queries, retrieves papers from your chosen source, expands citations where supported, and ranks relevance. Explore the results in a bilingual Web workspace, save local history, and export a reading list.

[Project overview](https://github.com/paperseek/paperseek) · [Documentation](https://docs.paperseek.app/) · [中文文档](https://docs.paperseek.app/zh/) · [Try online](https://paperseek.app/)

## Install

Requires Python 3.12 or newer. The release package includes the Web UI.

```sh
python -m pip install "paperseek==1.0.0b2"
paperseek serve
```

Open [http://127.0.0.1:8765](http://127.0.0.1:8765). Configure a model API and data source in the application.

## Capabilities

- Eight scholarly sources: OpenAlex, arXiv, Crossref, Semantic Scholar, PubMed, Google Scholar via Serper, PaperHub, and Web of Science Starter.
- Query iteration, bounded candidate retrieval, optional citation expansion, and relevance ranking.
- OpenAI Responses, OpenAI-compatible Chat Completions, and Anthropic Messages model protocols.
- Local fusion, Embedding + Rerank, or System One preliminary ranking.
- Search history, filters, selection, citation maps, and complete CSV/JSON exports.
- **Experimental** abstract-based reviews with editable outlines, section writing, versions, and Markdown/Word/BibTeX exports.

A run begins with one selected data source. Search is bounded, not guaranteed exhaustive; reviews use available abstracts and metadata rather than automatically read full texts.

## Terminal and integrations

The CLI provides `serve`, `worker`, `search`, `doctor`, `migrate`, and `version`. Configure process environment variables before a terminal search; a nearby `.env` is not loaded automatically.

```sh
paperseek search "How does open-source funding affect maintenance?" --source openalex --search-budget medium --output json
```

The local HTTP API is under `/api/v1`, with its schema at `/openapi.json`. MCP is packaged separately:

```sh
python -m pip install "paperseek-mcp==1.0.0b2"
paperseek-mcp --transport stdio
```

## Data and upgrades

Community stores history in `~/.paperseek/paperseek.db` by default, with artifacts and credential-encryption material in its data directory. Back up the complete directory consistently.

For Docker, separate workers, and 0.2 migration, see [self-hosting](https://docs.paperseek.app/self-hosting/) and [upgrading](https://docs.paperseek.app/self-hosting/upgrade).

## Development and license

The source distribution uses `paperseek_core` for research behavior, `paperseek_app` for use cases and ports, and `paperseek_community` for local adapters. Hosted consumes a fixed Community distribution. Common Vue sources are included for Hosted builds; installed Community serves the prebuilt assets.

[Development guide](https://docs.paperseek.app/contributing) · [Report an issue](https://github.com/paperseek/paperseek/issues) · [Apache-2.0 license](https://github.com/paperseek/paperseek/blob/main/LICENSE)
