research-scan 0.5.0__tar.gz

research_scan-0.5.0/.claude-plugin/plugin.json

@@ -0,0 +1,5 @@
+{
+  "name": "research-scan",
+  "version": "0.5.0",
+  "description": "Find the 5–10 recent papers with the highest impact on a research question, topic, or project. Multi-query scholarly retrieval (OpenAlex, Semantic Scholar, arXiv), citation-graph expansion, rubric-based screening and reranking, DOI verification."
+}

research_scan-0.5.0/.env.example

@@ -0,0 +1,23 @@
+# research-scan credentials.
+#
+# Copy to ~/.config/research-scan/.env (preferred — works from any directory once
+# `uv tool install` has put the CLI on PATH), or to ./.env for repo-local dev.
+#
+# Precedence, highest first:  process environment  >  ~/.config/research-scan/.env  >  ./.env
+#
+# Only OPENALEX_API_KEY is mandatory (`research-scan doctor` exits 3 without it).
+
+# Mandatory. Free key, ~$1/day free allowance: https://openalex.org/
+OPENALEX_API_KEY=
+
+# Strongly recommended: raises the OpenAlex rate limit to 5 req/s and puts you in
+# the Crossref polite pool (sent in the User-Agent). Not a secret.
+OPENALEX_MAILTO=
+
+# Optional. Free key, 1 req/s: https://www.semanticscholar.org/product/api
+# Without it, Semantic Scholar is throttled to ~0.3 req/s and doctor WARNs.
+S2_API_KEY=
+
+# Optional. Raises NCBI E-utilities from 3 req/s to 10 req/s. Only matters once the PubMed
+# source is built — `biomed` routes to it today but it is recorded as unavailable.
+NCBI_API_KEY=

research_scan-0.5.0/.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: release
+
+# Tags only. Nothing here runs on a push to main or on a pull request, so the
+# publish path cannot be reached except by cutting a tag.
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: astral-sh/setup-uv@v10.0.1
+        with:
+          enable-cache: true
+
+      - name: Install the locked dependency set
+        run: uv sync --locked
+
+      - name: Lint
+        run: uv run ruff check
+
+      - name: Test
+        run: uv run pytest
+
+      # The tag is the release's only claim about which version this is, and
+      # importlib.metadata reads the version out of the built distribution. If the
+      # two disagree, the published artifact would carry a version nobody tagged.
+      - name: Tag must match the package version
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          pyproject_version="$(uv run python -c 'import tomllib,pathlib; print(tomllib.loads(pathlib.Path("pyproject.toml").read_text())["project"]["version"])')"
+          echo "tag:        ${GITHUB_REF_NAME} (version ${tag_version})"
+          echo "pyproject:  ${pyproject_version}"
+          if [ "${tag_version}" != "${pyproject_version}" ]; then
+            echo "::error title=Version mismatch::tag ${GITHUB_REF_NAME} does not match pyproject.toml version ${pyproject_version}. Bump pyproject.toml or retag; do not publish this build."
+            exit 1
+          fi
+
+      - name: Build
+        run: uv build
+
+      # The repo passing its own tests is not evidence the artifact works. Install the
+      # wheel somewhere that has none of the source tree on the path and run it.
+      - name: Smoke-test the built wheel
+        run: |
+          python3 -m venv /tmp/smoke
+          /tmp/smoke/bin/pip install --quiet --upgrade pip
+          /tmp/smoke/bin/pip install --quiet dist/*.whl
+          installed_version="$(/tmp/smoke/bin/research-scan --version)"
+          echo "wheel reports: ${installed_version}"
+          if [ "${installed_version}" != "${GITHUB_REF_NAME#v}" ]; then
+            echo "::error title=Wheel version mismatch::installed wheel reports ${installed_version}, expected ${GITHUB_REF_NAME#v}"
+            exit 1
+          fi
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      # The only credential this job gets. There is no API token anywhere in this
+      # workflow or in the repository's secrets: PyPI Trusted Publishing exchanges
+      # this short-lived OIDC token for an upload token at publish time.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

research_scan-0.5.0/.gitignore

@@ -0,0 +1,26 @@
+.env
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+eval/results/*
+!eval/results/.gitkeep
+# The documented V1 acceptance run. Narrow negation on purpose — ad-hoc result files stay out.
+!eval/results/2026-08-19-defaults-savings.json
+!eval/results/2026-08-19-llm-lit-search.json
+
+.DS_Store
+
+# Scan outputs — runs are local artefacts, not repo content.
+# Excluded per level rather than as `research/`: git will not descend into an excluded directory,
+# so a negation inside one never fires. Narrow, the same way eval/results keeps only its
+# documented acceptance runs — here, the two transport runs behind the v0.4.0 tag.
+research/*
+!research/scans/
+research/scans/*
+!research/scans/2026-08-20-agentic-lit-search-mcp-transport/
+!research/scans/2026-08-20-agentic-lit-search-orientation-mcp-transport/
+
+# Built skill package — a build artefact, rebuilt from skills/research-scan/
+dist/

research_scan-0.5.0/.python-version

@@ -0,0 +1 @@
+3.13