citegraph 0.2.0__tar.gz

citegraph-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install package
+        run: python -m pip install -e ".[dev]"
+
+      - name: Run tests
+        run: python -m pytest tests/test_*.py -vv
+
+      - name: Run Ruff
+        run: ruff check .
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: Install build tools
+        run: python -m pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package metadata
+        run: python -m twine check dist/*
+
+      - name: Upload distribution artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/*

citegraph-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: Install build tools
+        run: python -m pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package metadata
+        run: python -m twine check dist/*
+
+      - name: Upload distribution artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/*
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/citegraph
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distribution artifact
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1

citegraph-0.2.0/.gitignore

@@ -0,0 +1,54 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+pip-wheel-metadata/
+
+# Virtual envs
+.venv/
+venv/
+env/
+
+# Tests / coverage
+.pytest_cache/
+.ruff_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+
+# Tooling
+.mypy_cache/
+.pyre/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/
+*.swp
+
+# Env / secrets
+.env
+.env.*
+!.env.example
+
+# Pipeline outputs (local runs)
+out/
+out_archive/
+
+# Notebooks are local exploratory artifacts.
+*.ipynb
+
+# ...except the curated example notebook.
+!examples/quickstart.ipynb
+
+# Per-machine Claude Code settings (tool permissions, absolute paths).
+# Project skills under .claude/skills/ are shared and stay tracked.
+.claude/settings.local.json

citegraph-0.2.0/.jupyter-config/migrated

@@ -0,0 +1 @@
+2026-09-06T15:21:04.556495+00:00

citegraph-0.2.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## 0.2.0 — 2026-11-01
+
+Public research beta. This release replaces the earlier papers/references model
+with a unified works model. Review generated records before using them in research.
+
+### Breaking changes and migration
+
+- Source papers and cited references now share canonical `w-` work IDs, with
+  discovery depth in `ring` and processed-PDF provenance in `source_file`.
+- `sources.csv`, `citations_raw.csv`, `works.csv`, and `citation_graph.csv`
+  replace the old papers/references artifacts. `PipelineResult` and
+  `CitationGraph` expose the unified works model.
+- Rebuild existing outputs in a copy using the
+  [migration guide](docs/USER_GUIDE.md#rebuild-an-existing-corpus-in-a-copy).
+  Preserve identity registries, correction files, and extraction caches. Corrected
+  clusters can change IDs, citation counts, and rankings; invalidated or missing
+  caches can require new provider calls.
+
+### Added and improved
+
+- Work and author resolution safeguards, saved decision audits, manual identity
+  constraints, stable identity registries, and fingerprinted incremental caches.
+- Enrichment over core and cited works, author-agreement checks, OpenAlex API-key
+  support, transient-failure retries, and conservative journal normalization.
+- Automatic OCR retries for image-only and glyph-corrupted conversions, extraction
+  failure isolation, and atomic JSON and CSV checkpoints.
+- Author co-citation networks and per-tie comparison tests, optional plotting,
+  core-author Excel export, work annotations, and title-page JEL extraction.
+- A read-only local monitor, self-contained quality-control reports, a staged user
+  guide, and a finished demo corpus that can be queried without an API key.
+- Optional PDF conversion dependencies; the PDF extras include EasyOCR support.
+
+### Known limitations
+
+- Human-reviewed, held-out corpus accuracy has not been established. Synthetic
+  evaluation results measure regression coverage, not extraction or matching
+  accuracy on arbitrary literature.
+- Work clustering can depend on input order for ambiguous matches. Archive inputs,
+  outputs, corrections, and the package version for reproducible analysis.
+- Extraction requires Gemini and sends converted paper text to Google. Cost
+  estimates are approximate; the `metadata` command and Python API do not prompt
+  for cost approval.
+- `CITEGRAPH_REQUEST_TIMEOUT_S` is defined but is not yet applied to Gemini calls.
+- Overlapping author ties do not support a confirmatory combined p-value; the
+  Fisher diagnostic assumes independent ties.

citegraph-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 citegraph contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.