Skip to content

PKB Starter v0.6.8-alpha — Scholarly Metadata Enrichment

Pre-release
Pre-release

Choose a tag to compare

@Clockworkhg Clockworkhg released this 13 Jun 12:16

🆕 What's New

  • Scholarly Literature Detection — automatic recognition via DOI, ISSN, arXiv, PMID, and structured metadata signals.

  • Crossref Metadata Enrichment — author, title, journal, year, volume, pages, publisher.

  • OpenAlex Work & Source Metrics (optional) — citation counts, open access status, source rankings.

  • Local Journal-Ranking Registry — user-imported CSSCI, PKU Core, AMI, CSCD, and custom lists. Journal matching via DOI-resolved ISSN, ISSN, EISSN, ISSN-L, normalized names, and fuzzy matching.

  • Citation Formatting — GB/T 7714 journal-article, APA 7 (citeproc-py), BibTeX, RIS, CSL-JSON export.

  • Batch Enrichment — dry-run, write, only-missing, JSONL, resumable jobs, locked-page protection.

  • Structured Literature Filtering — by ranking scheme, edition, level, year, journal, DOI, citation count, review status.

Usage

# Batch enrich existing literature
python tools/scholarly_enrich.py --scan wiki/ --write
python tools/scholarly_enrich.py --scan wiki/ --write --only-missing
python tools/scholarly_enrich.py --scan wiki/ --write --resume

# Filter literature
python tools/filter_literature.py --ranking CSSCI --year-from 2023 --min-citations 5

# Import journal rankings
python tools/import_journal_rankings.py import rankings.csv

⬆️ Upgrading

# Optional: install APA 7 formatting dependencies
pip install -r tools/requirements-scholarly.txt

# Optional: set OpenAlex API key for enhanced metrics
set OPENALEX_API_KEY=your_key_here

# Update system files
python tools/pkb_update_client.py --apply

Core PKB workflow works without optional dependencies.

🔒 Privacy & Security

  • Private PKB content is never synchronized to the public repository.
  • Imported journal-ranking datasets remain under .pkb_local/scholarly/ (gitignored).
  • Cache databases and resumable job state remain local.
  • API keys read only from environment variables.
  • Crossref/OpenAlex failures do not block ordinary /pkb ingestion.
  • No complete proprietary journal-ranking lists are bundled.

🧪 Test Results

Suite Tests Result
Private PKB 611 ✅ passed
pkb-starter template 568 ✅ passed
Fresh install (scholarly + CLI) 568 ✅ passed

Full Changelog: CHANGELOG.md