Skip to main content

CLI tool for automated literature research workflows.

Project description

litresearch

CI PyPI

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

litresearch-0.1.0.tar.gz (128.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

litresearch-0.1.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file litresearch-0.1.0.tar.gz.

File metadata

  • Download URL: litresearch-0.1.0.tar.gz
  • Upload date:
  • Size: 128.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for litresearch-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3fe83b7d3f881492e1aacafb50d0f068cd044d4056923f2b93ce95986d21f02e
MD5 d96752a9dfdf58db733bb00d938637dd
BLAKE2b-256 eaa99ac08930b88a880a08581daf2f538be21085de1bc481b59f8751c32d95e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for litresearch-0.1.0.tar.gz:

Publisher: release.yml on spignotti/litresearch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file litresearch-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: litresearch-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for litresearch-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36970077f6cae4e6edfcad22425af3254d90c7e2eb69e5db5dd6afa598cf5753
MD5 c43cd90f6e6b3e3c91e6cb5cda24c2fc
BLAKE2b-256 a4d1f2dbb80e569592cc0996c2bb63f7088431f6c90435d57cc9f3ab28934709

See more details on using hashes here.

Provenance

The following attestation bundles were made for litresearch-0.1.0-py3-none-any.whl:

Publisher: release.yml on spignotti/litresearch

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page