Metadata-Version: 2.4
Name: opencite
Version: 0.1.1
Summary: Academic literature search, citation management, and PDF retrieval CLI
Project-URL: Repository, https://github.com/neuromechanist/opencite
Project-URL: Issues, https://github.com/neuromechanist/opencite/issues
Author-email: Seyed Yahya Shirazi <shirazi@ieee.org>
License-Expression: MIT
License-File: LICENSE
Keywords: academic,bibtex,citations,literature,openalex,pdf,pubmed,search,semantic-scholar
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27.0
Requires-Dist: pyalex>=0.15
Provides-Extra: convert
Requires-Dist: markit-mistral; extra == 'convert'
Requires-Dist: markitdown>=0.1.0; extra == 'convert'
Provides-Extra: dev
Requires-Dist: pre-commit>=4.0.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.8.0; extra == 'dev'
Description-Content-Type: text/markdown

# OpenCite

Academic literature search, citation management, and PDF retrieval CLI.

Searches Semantic Scholar, OpenAlex, and PubMed in parallel, deduplicates results, and supports BibTeX output, citation graph traversal, PDF retrieval, and PDF-to-markdown conversion.

## Installation

```bash
pip install opencite
```

With PDF conversion support:

```bash
pip install opencite[convert]
```

For development:

```bash
git clone https://github.com/neuromechanist/opencite.git
cd opencite
uv sync --extra dev
```

## Claude Code Plugin

OpenCite is available as a [Claude Code](https://claude.ai/code) plugin, giving Claude direct access to academic literature search and citation management.

To install:

1. Open Claude Code
2. Type `/plugin` and press Enter
3. Select "Add marketplace"
4. Enter `neuromechanist/opencite`
5. Restart Claude Code

Once installed, use `/opencite` or ask Claude to search for papers, look up DOIs, get BibTeX, etc.

## Quick Start

```bash
# Search for papers
opencite search "transformer attention mechanism"

# Look up a paper by DOI
opencite lookup 10.1038/nature12345

# Find most-cited papers in a field
opencite canonical "deep learning for neuroscience" --min-citations 500

# Get papers citing a specific work
opencite cite 10.1038/nature12345

# Download a PDF
opencite pdf 10.1038/nature12345 -o papers/
```

## Configuration

Set API keys in a `.env` file or as environment variables:

```
SEMANTIC_SCHOLAR_API_KEY=your_key
PUBMED_API_KEY=your_key
OPENALEX_API_KEY=your_key
MISTRAL_API_KEY=your_key          # for PDF-to-markdown via Mistral OCR
```
